- Turned some FINFO rprintf() calls into FCLIENT calls that don't go
[rsync/rsync.git] / flist.c
1 /*
2  * Generate and receive file lists.
3  *
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
8  *
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.
13  *
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.
18  *
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.
22  */
23
24 #include "rsync.h"
25
26 extern int verbose;
27 extern int list_only;
28 extern int am_root;
29 extern int am_server;
30 extern int am_daemon;
31 extern int am_sender;
32 extern int do_progress;
33 extern int always_checksum;
34 extern int module_id;
35 extern int ignore_errors;
36 extern int numeric_ids;
37 extern int recurse;
38 extern int xfer_dirs;
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;
58
59 extern char curr_dir[MAXPATHLEN];
60
61 extern struct chmod_mode_struct *chmod_modes;
62
63 extern struct filter_list_struct filter_list;
64 extern struct filter_list_struct server_filter_list;
65
66 int io_error;
67 int checksum_len;
68 dev_t filesystem_dev; /* used to implement -x */
69 unsigned int file_struct_len;
70
71 static char empty_sum[MD4_SUM_LENGTH];
72 static int flist_count_offset;
73
74 static void clean_flist(struct file_list *flist, int strip_root, int no_dups);
75 static void output_flist(struct file_list *flist);
76
77 void init_flist(void)
78 {
79         struct file_struct f;
80
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;
84 }
85
86 static int show_filelist_p(void)
87 {
88         return verbose && xfer_dirs && !am_server;
89 }
90
91 static void start_filelist_progress(char *kind)
92 {
93         rprintf(FCLIENT, "%s ... ", kind);
94         if (verbose > 1 || do_progress)
95                 rprintf(FCLIENT, "\n");
96         rflush(FINFO);
97 }
98
99 static void emit_filelist_progress(int count)
100 {
101         rprintf(FCLIENT, " %d files...\r", count);
102 }
103
104 static void maybe_emit_filelist_progress(int count)
105 {
106         if (do_progress && show_filelist_p() && (count % 100) == 0)
107                 emit_filelist_progress(count);
108 }
109
110 static void finish_filelist_progress(const struct file_list *flist)
111 {
112         if (do_progress) {
113                 /* This overwrites the progress line */
114                 rprintf(FINFO, "%d file%sto consider\n",
115                         flist->count, flist->count == 1 ? " " : "s ");
116         } else
117                 rprintf(FINFO, "done\n");
118 }
119
120 void show_flist_stats(void)
121 {
122         /* Nothing yet */
123 }
124
125 static void list_file_entry(struct file_struct *f)
126 {
127         char permbuf[PERMSTRING_SIZE];
128
129         if (!f->basename) {
130                 /* this can happen if duplicate names were removed */
131                 return;
132         }
133
134         permstring(permbuf, f->mode);
135
136 #ifdef SUPPORT_LINKS
137         if (preserve_links && S_ISLNK(f->mode)) {
138                 rprintf(FINFO, "%s %11.0f %s %s -> %s\n",
139                         permbuf,
140                         (double)f->length, timestring(f->modtime),
141                         f_name(f, NULL), f->u.link);
142         } else
143 #endif
144         {
145                 rprintf(FINFO, "%s %11.0f %s %s\n",
146                         permbuf,
147                         (double)f->length, timestring(f->modtime),
148                         f_name(f, NULL));
149         }
150 }
151
152 /* Stat either a symlink or its referent, depending on the settings of
153  * copy_links, copy_unsafe_links, etc.  Returns -1 on error, 0 on success.
154  *
155  * If path is the name of a symlink, then the linkbuf buffer (which must hold
156  * MAXPATHLEN chars) will be set to the symlink's target string.
157  *
158  * The stat structure pointed to by stp will contain information about the
159  * link or the referent as appropriate, if they exist. */
160 static int readlink_stat(const char *path, STRUCT_STAT *stp, char *linkbuf)
161 {
162 #ifdef SUPPORT_LINKS
163         if (link_stat(path, stp, copy_dirlinks) < 0)
164                 return -1;
165         if (S_ISLNK(stp->st_mode)) {
166                 int llen = readlink(path, linkbuf, MAXPATHLEN - 1);
167                 if (llen < 0)
168                         return -1;
169                 linkbuf[llen] = '\0';
170                 if (copy_unsafe_links && unsafe_symlink(linkbuf, path)) {
171                         if (verbose > 1) {
172                                 rprintf(FINFO,"copying unsafe symlink \"%s\" -> \"%s\"\n",
173                                         path, linkbuf);
174                         }
175                         return safe_stat(path, stp);
176                 }
177         }
178         return 0;
179 #else
180         return do_stat(path, stp);
181 #endif
182 }
183
184 int link_stat(const char *path, STRUCT_STAT *stp, int follow_dirlinks)
185 {
186 #ifdef SUPPORT_LINKS
187         if (copy_links)
188                 return safe_stat(path, stp);
189         if (do_lstat(path, stp) < 0)
190                 return -1;
191         if (follow_dirlinks && S_ISLNK(stp->st_mode)) {
192                 STRUCT_STAT st;
193                 if (safe_stat(path, &st) == 0 && S_ISDIR(st.st_mode))
194                         *stp = st;
195         }
196         return 0;
197 #else
198         return do_stat(path, stp);
199 #endif
200 }
201
202 /* This function is used to check if a file should be included/excluded
203  * from the list of files based on its name and type etc.  The value of
204  * filter_level is set to either SERVER_FILTERS or ALL_FILTERS. */
205 static int is_excluded(char *fname, int is_dir, int filter_level)
206 {
207 #if 0 /* This currently never happens, so avoid a useless compare. */
208         if (filter_level == NO_FILTERS)
209                 return 0;
210 #endif
211         if (fname) {
212                 /* never exclude '.', even if somebody does --exclude '*' */
213                 if (fname[0] == '.' && !fname[1])
214                         return 0;
215                 /* Handle the -R version of the '.' dir. */
216                 if (fname[0] == '/') {
217                         int len = strlen(fname);
218                         if (fname[len-1] == '.' && fname[len-2] == '/')
219                                 return 0;
220                 }
221         }
222         if (server_filter_list.head
223             && check_filter(&server_filter_list, fname, is_dir) < 0)
224                 return 1;
225         if (filter_level != ALL_FILTERS)
226                 return 0;
227         if (filter_list.head
228             && check_filter(&filter_list, fname, is_dir) < 0)
229                 return 1;
230         return 0;
231 }
232
233 static int to_wire_mode(mode_t mode)
234 {
235 #ifdef SUPPORT_LINKS
236         if (S_ISLNK(mode) && (_S_IFLNK != 0120000))
237                 return (mode & ~(_S_IFMT)) | 0120000;
238 #endif
239         return (int)mode;
240 }
241
242 static mode_t from_wire_mode(int mode)
243 {
244         if ((mode & (_S_IFMT)) == 0120000 && (_S_IFLNK != 0120000))
245                 return (mode & ~(_S_IFMT)) | _S_IFLNK;
246         return (mode_t)mode;
247 }
248
249 static void send_directory(int f, struct file_list *flist,
250                            char *fbuf, int len);
251
252 static char *flist_dir;
253 static int flist_dir_len;
254
255
256 /**
257  * Make sure @p flist is big enough to hold at least @p flist->count
258  * entries.
259  **/
260 void flist_expand(struct file_list *flist)
261 {
262         struct file_struct **new_ptr;
263
264         if (flist->count < flist->malloced)
265                 return;
266
267         if (flist->malloced < FLIST_START)
268                 flist->malloced = FLIST_START;
269         else if (flist->malloced >= FLIST_LINEAR)
270                 flist->malloced += FLIST_LINEAR;
271         else
272                 flist->malloced *= 2;
273
274         /*
275          * In case count jumped or we are starting the list
276          * with a known size just set it.
277          */
278         if (flist->malloced < flist->count)
279                 flist->malloced = flist->count;
280
281         new_ptr = realloc_array(flist->files, struct file_struct *,
282                                 flist->malloced);
283
284         if (verbose >= 2 && flist->malloced != FLIST_START) {
285                 rprintf(FCLIENT, "[%s] expand file_list to %.0f bytes, did%s move\n",
286                     who_am_i(),
287                     (double)sizeof flist->files[0] * flist->malloced,
288                     (new_ptr == flist->files) ? " not" : "");
289         }
290
291         flist->files = new_ptr;
292
293         if (!flist->files)
294                 out_of_memory("flist_expand");
295 }
296
297 static void send_file_entry(struct file_struct *file, int f)
298 {
299         unsigned short flags;
300         static time_t modtime;
301         static mode_t mode;
302         static int64 dev;
303         static dev_t rdev;
304         static uint32 rdev_major;
305         static uid_t uid;
306         static gid_t gid;
307         static char lastname[MAXPATHLEN];
308         char fname[MAXPATHLEN];
309         int l1, l2;
310
311         if (f < 0)
312                 return;
313
314         if (!file) {
315                 write_byte(f, 0);
316                 modtime = 0, mode = 0;
317                 dev = 0, rdev = makedev(0, 0);
318                 rdev_major = 0;
319                 uid = 0, gid = 0;
320                 *lastname = '\0';
321                 return;
322         }
323
324         f_name(file, fname);
325
326         flags = file->flags & XMIT_TOP_DIR;
327
328         if (file->mode == mode)
329                 flags |= XMIT_SAME_MODE;
330         else
331                 mode = file->mode;
332         if ((preserve_devices && IS_DEVICE(mode))
333          || (preserve_specials && IS_SPECIAL(mode))) {
334                 if (protocol_version < 28) {
335                         if (file->u.rdev == rdev)
336                                 flags |= XMIT_SAME_RDEV_pre28;
337                         else
338                                 rdev = file->u.rdev;
339                 } else {
340                         rdev = file->u.rdev;
341                         if ((uint32)major(rdev) == rdev_major)
342                                 flags |= XMIT_SAME_RDEV_MAJOR;
343                         else
344                                 rdev_major = major(rdev);
345                         if ((uint32)minor(rdev) <= 0xFFu)
346                                 flags |= XMIT_RDEV_MINOR_IS_SMALL;
347                 }
348         } else if (protocol_version < 28)
349                 rdev = makedev(0, 0);
350         if (file->uid == uid)
351                 flags |= XMIT_SAME_UID;
352         else
353                 uid = file->uid;
354         if (file->gid == gid)
355                 flags |= XMIT_SAME_GID;
356         else
357                 gid = file->gid;
358         if (file->modtime == modtime)
359                 flags |= XMIT_SAME_TIME;
360         else
361                 modtime = file->modtime;
362
363 #ifdef SUPPORT_HARD_LINKS
364         if (file->link_u.idev) {
365                 if (file->F_DEV == dev) {
366                         if (protocol_version >= 28)
367                                 flags |= XMIT_SAME_DEV;
368                 } else
369                         dev = file->F_DEV;
370                 flags |= XMIT_HAS_IDEV_DATA;
371         }
372 #endif
373
374         for (l1 = 0;
375             lastname[l1] && (fname[l1] == lastname[l1]) && (l1 < 255);
376             l1++) {}
377         l2 = strlen(fname+l1);
378
379         if (l1 > 0)
380                 flags |= XMIT_SAME_NAME;
381         if (l2 > 255)
382                 flags |= XMIT_LONG_NAME;
383
384         /* We must make sure we don't send a zero flag byte or the
385          * other end will terminate the flist transfer.  Note that
386          * the use of XMIT_TOP_DIR on a non-dir has no meaning, so
387          * it's harmless way to add a bit to the first flag byte. */
388         if (protocol_version >= 28) {
389                 if (!flags && !S_ISDIR(mode))
390                         flags |= XMIT_TOP_DIR;
391                 if ((flags & 0xFF00) || !flags) {
392                         flags |= XMIT_EXTENDED_FLAGS;
393                         write_byte(f, flags);
394                         write_byte(f, flags >> 8);
395                 } else
396                         write_byte(f, flags);
397         } else {
398                 if (!(flags & 0xFF))
399                         flags |= S_ISDIR(mode) ? XMIT_LONG_NAME : XMIT_TOP_DIR;
400                 write_byte(f, flags);
401         }
402         if (flags & XMIT_SAME_NAME)
403                 write_byte(f, l1);
404         if (flags & XMIT_LONG_NAME)
405                 write_int(f, l2);
406         else
407                 write_byte(f, l2);
408         write_buf(f, fname + l1, l2);
409
410         write_longint(f, file->length);
411         if (!(flags & XMIT_SAME_TIME))
412                 write_int(f, modtime);
413         if (!(flags & XMIT_SAME_MODE))
414                 write_int(f, to_wire_mode(mode));
415         if (preserve_uid && !(flags & XMIT_SAME_UID)) {
416                 if (!numeric_ids)
417                         add_uid(uid);
418                 write_int(f, uid);
419         }
420         if (preserve_gid && !(flags & XMIT_SAME_GID)) {
421                 if (!numeric_ids)
422                         add_gid(gid);
423                 write_int(f, gid);
424         }
425         if ((preserve_devices && IS_DEVICE(mode))
426          || (preserve_specials && IS_SPECIAL(mode))) {
427                 if (protocol_version < 28) {
428                         if (!(flags & XMIT_SAME_RDEV_pre28))
429                                 write_int(f, (int)rdev);
430                 } else {
431                         if (!(flags & XMIT_SAME_RDEV_MAJOR))
432                                 write_int(f, major(rdev));
433                         if (flags & XMIT_RDEV_MINOR_IS_SMALL)
434                                 write_byte(f, minor(rdev));
435                         else
436                                 write_int(f, minor(rdev));
437                 }
438         }
439
440 #ifdef SUPPORT_LINKS
441         if (preserve_links && S_ISLNK(mode)) {
442                 int len = strlen(file->u.link);
443                 write_int(f, len);
444                 write_buf(f, file->u.link, len);
445         }
446 #endif
447
448 #ifdef SUPPORT_HARD_LINKS
449         if (flags & XMIT_HAS_IDEV_DATA) {
450                 if (protocol_version < 26) {
451                         /* 32-bit dev_t and ino_t */
452                         write_int(f, dev);
453                         write_int(f, file->F_INODE);
454                 } else {
455                         /* 64-bit dev_t and ino_t */
456                         if (!(flags & XMIT_SAME_DEV))
457                                 write_longint(f, dev);
458                         write_longint(f, file->F_INODE);
459                 }
460         }
461 #endif
462
463         if (always_checksum && (S_ISREG(mode) || protocol_version < 28)) {
464                 char *sum;
465                 if (S_ISREG(mode))
466                         sum = file->u.sum;
467                 else {
468                         /* Prior to 28, we sent a useless set of nulls. */
469                         sum = empty_sum;
470                 }
471                 write_buf(f, sum, checksum_len);
472         }
473
474         strlcpy(lastname, fname, MAXPATHLEN);
475 }
476
477 static struct file_struct *receive_file_entry(struct file_list *flist,
478                                               unsigned short flags, int f)
479 {
480         static time_t modtime;
481         static mode_t mode;
482         static int64 dev;
483         static dev_t rdev;
484         static uint32 rdev_major;
485         static uid_t uid;
486         static gid_t gid;
487         static char lastname[MAXPATHLEN], *lastdir;
488         static int lastdir_depth, lastdir_len = -1;
489         static unsigned int del_hier_name_len = 0;
490         static int in_del_hier = 0;
491         char thisname[MAXPATHLEN];
492         unsigned int l1 = 0, l2 = 0;
493         int alloc_len, basename_len, dirname_len, linkname_len, sum_len;
494         OFF_T file_length;
495         char *basename, *dirname, *bp;
496         struct file_struct *file;
497
498         if (!flist) {
499                 modtime = 0, mode = 0;
500                 dev = 0, rdev = makedev(0, 0);
501                 rdev_major = 0;
502                 uid = 0, gid = 0;
503                 *lastname = '\0';
504                 lastdir_len = -1;
505                 in_del_hier = 0;
506                 return NULL;
507         }
508
509         if (flags & XMIT_SAME_NAME)
510                 l1 = read_byte(f);
511
512         if (flags & XMIT_LONG_NAME)
513                 l2 = read_int(f);
514         else
515                 l2 = read_byte(f);
516
517         if (l2 >= MAXPATHLEN - l1) {
518                 rprintf(FERROR,
519                         "overflow: flags=0x%x l1=%d l2=%d lastname=%s\n",
520                         flags, l1, l2, lastname);
521                 overflow_exit("receive_file_entry");
522         }
523
524         strlcpy(thisname, lastname, l1 + 1);
525         read_sbuf(f, &thisname[l1], l2);
526         thisname[l1 + l2] = 0;
527
528         strlcpy(lastname, thisname, MAXPATHLEN);
529
530         clean_fname(thisname, 0);
531
532         if (sanitize_paths)
533                 sanitize_path(thisname, thisname, "", 0, NULL);
534
535         if ((basename = strrchr(thisname, '/')) != NULL) {
536                 dirname_len = ++basename - thisname; /* counts future '\0' */
537                 if (lastdir_len == dirname_len - 1
538                     && strncmp(thisname, lastdir, lastdir_len) == 0) {
539                         dirname = lastdir;
540                         dirname_len = 0; /* indicates no copy is needed */
541                 } else
542                         dirname = thisname;
543         } else {
544                 basename = thisname;
545                 dirname = NULL;
546                 dirname_len = 0;
547         }
548         basename_len = strlen(basename) + 1; /* count the '\0' */
549
550         file_length = read_longint(f);
551         if (!(flags & XMIT_SAME_TIME))
552                 modtime = (time_t)read_int(f);
553         if (!(flags & XMIT_SAME_MODE))
554                 mode = from_wire_mode(read_int(f));
555
556         if (chmod_modes && !S_ISLNK(mode))
557                 mode = tweak_mode(mode, chmod_modes);
558
559         if (preserve_uid && !(flags & XMIT_SAME_UID))
560                 uid = (uid_t)read_int(f);
561         if (preserve_gid && !(flags & XMIT_SAME_GID))
562                 gid = (gid_t)read_int(f);
563
564         if ((preserve_devices && IS_DEVICE(mode))
565          || (preserve_specials && IS_SPECIAL(mode))) {
566                 if (protocol_version < 28) {
567                         if (!(flags & XMIT_SAME_RDEV_pre28))
568                                 rdev = (dev_t)read_int(f);
569                 } else {
570                         uint32 rdev_minor;
571                         if (!(flags & XMIT_SAME_RDEV_MAJOR))
572                                 rdev_major = read_int(f);
573                         if (flags & XMIT_RDEV_MINOR_IS_SMALL)
574                                 rdev_minor = read_byte(f);
575                         else
576                                 rdev_minor = read_int(f);
577                         rdev = makedev(rdev_major, rdev_minor);
578                 }
579         } else if (protocol_version < 28)
580                 rdev = makedev(0, 0);
581
582 #ifdef SUPPORT_LINKS
583         if (preserve_links && S_ISLNK(mode)) {
584                 linkname_len = read_int(f) + 1; /* count the '\0' */
585                 if (linkname_len <= 0 || linkname_len > MAXPATHLEN) {
586                         rprintf(FERROR, "overflow: linkname_len=%d\n",
587                                 linkname_len - 1);
588                         overflow_exit("receive_file_entry");
589                 }
590         }
591         else
592 #endif
593                 linkname_len = 0;
594
595         sum_len = always_checksum && S_ISREG(mode) ? MD4_SUM_LENGTH : 0;
596
597         alloc_len = file_struct_len + dirname_len + basename_len
598                   + linkname_len + sum_len;
599         bp = pool_alloc(flist->file_pool, alloc_len, "receive_file_entry");
600
601         file = (struct file_struct *)bp;
602         memset(bp, 0, file_struct_len);
603         bp += file_struct_len;
604
605         file->modtime = modtime;
606         file->length = file_length;
607         file->mode = mode;
608         file->uid = uid;
609         file->gid = gid;
610
611         if (dirname_len) {
612                 file->dirname = lastdir = bp;
613                 lastdir_len = dirname_len - 1;
614                 memcpy(bp, dirname, dirname_len - 1);
615                 bp += dirname_len;
616                 bp[-1] = '\0';
617                 lastdir_depth = count_dir_elements(lastdir);
618                 file->dir.depth = lastdir_depth + 1;
619         } else if (dirname) {
620                 file->dirname = dirname; /* we're reusing lastname */
621                 file->dir.depth = lastdir_depth + 1;
622         } else
623                 file->dir.depth = 1;
624
625         if (S_ISDIR(mode)) {
626                 if (basename_len == 1+1 && *basename == '.') /* +1 for '\0' */
627                         file->dir.depth--;
628                 if (flags & XMIT_TOP_DIR) {
629                         in_del_hier = recurse;
630                         del_hier_name_len = file->dir.depth == 0 ? 0 : l1 + l2;
631                         if (relative_paths && del_hier_name_len > 2
632                             && lastname[del_hier_name_len-1] == '.'
633                             && lastname[del_hier_name_len-2] == '/')
634                                 del_hier_name_len -= 2;
635                         file->flags |= FLAG_TOP_DIR | FLAG_DEL_HERE;
636                 } else if (in_del_hier) {
637                         if (!relative_paths || !del_hier_name_len
638                          || (l1 >= del_hier_name_len
639                           && lastname[del_hier_name_len] == '/'))
640                                 file->flags |= FLAG_DEL_HERE;
641                         else
642                                 in_del_hier = 0;
643                 }
644         }
645
646         file->basename = bp;
647         memcpy(bp, basename, basename_len);
648         bp += basename_len;
649
650         if ((preserve_devices && IS_DEVICE(mode))
651          || (preserve_specials && IS_SPECIAL(mode)))
652                 file->u.rdev = rdev;
653
654 #ifdef SUPPORT_LINKS
655         if (linkname_len) {
656                 file->u.link = bp;
657                 read_sbuf(f, bp, linkname_len - 1);
658                 bp += linkname_len;
659         }
660 #endif
661
662 #ifdef SUPPORT_HARD_LINKS
663         if (preserve_hard_links && protocol_version < 28 && S_ISREG(mode))
664                 flags |= XMIT_HAS_IDEV_DATA;
665         if (flags & XMIT_HAS_IDEV_DATA) {
666                 int64 inode;
667                 if (protocol_version < 26) {
668                         dev = read_int(f);
669                         inode = read_int(f);
670                 } else {
671                         if (!(flags & XMIT_SAME_DEV))
672                                 dev = read_longint(f);
673                         inode = read_longint(f);
674                 }
675                 if (flist->hlink_pool) {
676                         file->link_u.idev = pool_talloc(flist->hlink_pool,
677                             struct idev, 1, "inode_table");
678                         file->F_INODE = inode;
679                         file->F_DEV = dev;
680                 }
681         }
682 #endif
683
684         if (always_checksum && (sum_len || protocol_version < 28)) {
685                 char *sum;
686                 if (sum_len) {
687                         file->u.sum = sum = bp;
688                         /*bp += sum_len;*/
689                 } else {
690                         /* Prior to 28, we get a useless set of nulls. */
691                         sum = empty_sum;
692                 }
693                 read_buf(f, sum, checksum_len);
694         }
695
696         return file;
697 }
698
699 /**
700  * Create a file_struct for a named file by reading its stat()
701  * information and performing extensive checks against global
702  * options.
703  *
704  * @return the new file, or NULL if there was an error or this file
705  * should be excluded.
706  *
707  * @todo There is a small optimization opportunity here to avoid
708  * stat()ing the file in some circumstances, which has a certain cost.
709  * We are called immediately after doing readdir(), and so we may
710  * already know the d_type of the file.  We could for example avoid
711  * statting directories if we're not recursing, but this is not a very
712  * important case.  Some systems may not have d_type.
713  **/
714 struct file_struct *make_file(char *fname, struct file_list *flist,
715                               STRUCT_STAT *stp, unsigned short flags,
716                               int filter_level)
717 {
718         static char *lastdir;
719         static int lastdir_len = -1;
720         struct file_struct *file;
721         STRUCT_STAT st;
722         char sum[SUM_LENGTH];
723         char thisname[MAXPATHLEN];
724         char linkname[MAXPATHLEN];
725         int alloc_len, basename_len, dirname_len, linkname_len, sum_len;
726         char *basename, *dirname, *bp;
727
728         if (!flist || !flist->count)    /* Ignore lastdir when invalid. */
729                 lastdir_len = -1;
730
731         if (strlcpy(thisname, fname, sizeof thisname)
732             >= sizeof thisname - flist_dir_len) {
733                 rprintf(FINFO, "skipping overly long name: %s\n", fname);
734                 return NULL;
735         }
736         clean_fname(thisname, 0);
737         if (sanitize_paths)
738                 sanitize_path(thisname, thisname, "", 0, NULL);
739
740         memset(sum, 0, SUM_LENGTH);
741
742         if (stp && S_ISDIR(stp->st_mode))
743                 st = *stp; /* Needed for "symlink/." with --relative. */
744         else if (readlink_stat(thisname, &st, linkname) != 0) {
745                 int save_errno = errno;
746                 /* See if file is excluded before reporting an error. */
747                 if (filter_level != NO_FILTERS
748                     && is_excluded(thisname, 0, filter_level))
749                         return NULL;
750                 if (save_errno == ENOENT) {
751 #ifdef SUPPORT_LINKS
752                         /* Avoid "vanished" error if symlink points nowhere. */
753                         if (copy_links && do_lstat(thisname, &st) == 0
754                             && S_ISLNK(st.st_mode)) {
755                                 io_error |= IOERR_GENERAL;
756                                 rprintf(FERROR, "symlink has no referent: %s\n",
757                                         full_fname(thisname));
758                         } else
759 #endif
760                         {
761                                 enum logcode c = am_daemon && protocol_version < 28
762                                     ? FERROR : FINFO;
763                                 io_error |= IOERR_VANISHED;
764                                 rprintf(c, "file has vanished: %s\n",
765                                         full_fname(thisname));
766                         }
767                 } else {
768                         io_error |= IOERR_GENERAL;
769                         rsyserr(FERROR, save_errno, "readlink %s failed",
770                                 full_fname(thisname));
771                 }
772                 return NULL;
773         }
774
775         /* backup.c calls us with filter_level set to NO_FILTERS. */
776         if (filter_level == NO_FILTERS)
777                 goto skip_filters;
778
779         if (S_ISDIR(st.st_mode) && !xfer_dirs) {
780                 rprintf(FINFO, "skipping directory %s\n", thisname);
781                 return NULL;
782         }
783
784         /* We only care about directories because we need to avoid recursing
785          * into a mount-point directory, not to avoid copying a symlinked
786          * file if -L (or similar) was specified. */
787         if (one_file_system && st.st_dev != filesystem_dev
788          && S_ISDIR(st.st_mode)) {
789                 if (one_file_system > 1) {
790                         if (verbose > 2) {
791                                 rprintf(FINFO, "skipping mount-point dir %s\n",
792                                         thisname);
793                         }
794                         return NULL;
795                 }
796                 flags |= FLAG_MOUNT_POINT;
797         }
798
799         if (is_excluded(thisname, S_ISDIR(st.st_mode) != 0, filter_level))
800                 return NULL;
801
802         if (lp_ignore_nonreadable(module_id)) {
803 #ifdef SUPPORT_LINKS
804                 if (!S_ISLNK(st.st_mode))
805 #endif
806                         if (access(thisname, R_OK) != 0)
807                                 return NULL;
808         }
809
810   skip_filters:
811
812         if (verbose > 2) {
813                 rprintf(FINFO, "[%s] make_file(%s,*,%d)\n",
814                         who_am_i(), thisname, filter_level);
815         }
816
817         if ((basename = strrchr(thisname, '/')) != NULL) {
818                 dirname_len = ++basename - thisname; /* counts future '\0' */
819                 if (lastdir_len == dirname_len - 1
820                     && strncmp(thisname, lastdir, lastdir_len) == 0) {
821                         dirname = lastdir;
822                         dirname_len = 0; /* indicates no copy is needed */
823                 } else
824                         dirname = thisname;
825         } else {
826                 basename = thisname;
827                 dirname = NULL;
828                 dirname_len = 0;
829         }
830         basename_len = strlen(basename) + 1; /* count the '\0' */
831
832 #ifdef SUPPORT_LINKS
833         linkname_len = S_ISLNK(st.st_mode) ? strlen(linkname) + 1 : 0;
834 #else
835         linkname_len = 0;
836 #endif
837
838         sum_len = always_checksum && am_sender && S_ISREG(st.st_mode)
839                 ? MD4_SUM_LENGTH : 0;
840
841         alloc_len = file_struct_len + dirname_len + basename_len
842                   + linkname_len + sum_len;
843         if (flist)
844                 bp = pool_alloc(flist->file_pool, alloc_len, "make_file");
845         else {
846                 if (!(bp = new_array(char, alloc_len)))
847                         out_of_memory("make_file");
848         }
849
850         file = (struct file_struct *)bp;
851         memset(bp, 0, file_struct_len);
852         bp += file_struct_len;
853
854         file->flags = flags;
855         file->modtime = st.st_mtime;
856         file->length = st.st_size;
857         file->mode = st.st_mode;
858         file->uid = st.st_uid;
859         file->gid = st.st_gid;
860
861 #ifdef SUPPORT_HARD_LINKS
862         if (flist && flist->hlink_pool) {
863                 if (protocol_version < 28) {
864                         if (S_ISREG(st.st_mode))
865                                 file->link_u.idev = pool_talloc(
866                                     flist->hlink_pool, struct idev, 1,
867                                     "inode_table");
868                 } else {
869                         if (!S_ISDIR(st.st_mode) && st.st_nlink > 1)
870                                 file->link_u.idev = pool_talloc(
871                                     flist->hlink_pool, struct idev, 1,
872                                     "inode_table");
873                 }
874         }
875         if (file->link_u.idev) {
876                 file->F_DEV = st.st_dev;
877                 file->F_INODE = st.st_ino;
878         }
879 #endif
880
881         if (dirname_len) {
882                 file->dirname = lastdir = bp;
883                 lastdir_len = dirname_len - 1;
884                 memcpy(bp, dirname, dirname_len - 1);
885                 bp += dirname_len;
886                 bp[-1] = '\0';
887         } else if (dirname)
888                 file->dirname = dirname;
889
890         file->basename = bp;
891         memcpy(bp, basename, basename_len);
892         bp += basename_len;
893
894 #ifdef HAVE_STRUCT_STAT_ST_RDEV
895         if ((preserve_devices && IS_DEVICE(st.st_mode))
896          || (preserve_specials && IS_SPECIAL(st.st_mode)))
897                 file->u.rdev = st.st_rdev;
898 #endif
899
900 #ifdef SUPPORT_LINKS
901         if (linkname_len) {
902                 file->u.link = bp;
903                 memcpy(bp, linkname, linkname_len);
904                 bp += linkname_len;
905         }
906 #endif
907
908         if (sum_len) {
909                 file->u.sum = bp;
910                 file_checksum(thisname, bp, st.st_size);
911                 /*bp += sum_len;*/
912         }
913
914         file->dir.root = flist_dir;
915
916         /* This code is only used by the receiver when it is building
917          * a list of files for a delete pass. */
918         if (keep_dirlinks && linkname_len && flist) {
919                 STRUCT_STAT st2;
920                 int save_mode = file->mode;
921                 file->mode = S_IFDIR; /* Find a directory with our name. */
922                 if (flist_find(the_file_list, file) >= 0
923                     && safe_stat(thisname, &st2) == 0 && S_ISDIR(st2.st_mode)) {
924                         file->modtime = st2.st_mtime;
925                         file->length = st2.st_size;
926                         file->mode = st2.st_mode;
927                         file->uid = st2.st_uid;
928                         file->gid = st2.st_gid;
929                         file->u.link = NULL;
930                 } else
931                         file->mode = save_mode;
932         }
933
934         if (S_ISREG(st.st_mode) || S_ISLNK(st.st_mode))
935                 stats.total_size += st.st_size;
936
937         return file;
938 }
939
940 static struct file_struct *send_file_name(int f, struct file_list *flist,
941                                           char *fname, STRUCT_STAT *stp,
942                                           unsigned short flags)
943 {
944         struct file_struct *file;
945
946         file = make_file(fname, flist, stp, flags,
947                          f == -2 ? SERVER_FILTERS : ALL_FILTERS);
948         if (!file)
949                 return NULL;
950
951         if (chmod_modes && !S_ISLNK(file->mode))
952                 file->mode = tweak_mode(file->mode, chmod_modes);
953
954         maybe_emit_filelist_progress(flist->count + flist_count_offset);
955
956         flist_expand(flist);
957
958         if (file->basename[0]) {
959                 flist->files[flist->count++] = file;
960                 send_file_entry(file, f);
961         }
962         return file;
963 }
964
965 static void send_if_directory(int f, struct file_list *flist,
966                               struct file_struct *file,
967                               char *fbuf, unsigned int ol)
968 {
969         char is_dot_dir = fbuf[ol-1] == '.' && (ol == 1 || fbuf[ol-2] == '/');
970
971         if (S_ISDIR(file->mode)
972             && !(file->flags & FLAG_MOUNT_POINT) && f_name(file, fbuf)) {
973                 void *save_filters;
974                 unsigned int len = strlen(fbuf);
975                 if (len > 1 && fbuf[len-1] == '/')
976                         fbuf[--len] = '\0';
977                 if (len >= MAXPATHLEN - 1) {
978                         io_error |= IOERR_GENERAL;
979                         rprintf(FERROR, "skipping long-named directory: %s\n",
980                                 full_fname(fbuf));
981                         return;
982                 }
983                 save_filters = push_local_filters(fbuf, len);
984                 send_directory(f, flist, fbuf, len);
985                 pop_local_filters(save_filters);
986                 fbuf[ol] = '\0';
987                 if (is_dot_dir)
988                         fbuf[ol-1] = '.';
989         }
990 }
991
992 /* This function is normally called by the sender, but the receiving side also
993  * calls it from get_dirlist() with f set to -1 so that we just construct the
994  * file list in memory without sending it over the wire.  Also, get_dirlist()
995  * might call this with f set to -2, which also indicates that local filter
996  * rules should be ignored. */
997 static void send_directory(int f, struct file_list *flist,
998                            char *fbuf, int len)
999 {
1000         struct dirent *di;
1001         unsigned remainder;
1002         char *p;
1003         DIR *d;
1004         int start = flist->count;
1005
1006         if (!(d = opendir(fbuf))) {
1007                 io_error |= IOERR_GENERAL;
1008                 rsyserr(FERROR, errno, "opendir %s failed", full_fname(fbuf));
1009                 return;
1010         }
1011
1012         p = fbuf + len;
1013         if (len != 1 || *fbuf != '/')
1014                 *p++ = '/';
1015         *p = '\0';
1016         remainder = MAXPATHLEN - (p - fbuf);
1017
1018         for (errno = 0, di = readdir(d); di; errno = 0, di = readdir(d)) {
1019                 char *dname = d_name(di);
1020                 if (dname[0] == '.' && (dname[1] == '\0'
1021                     || (dname[1] == '.' && dname[2] == '\0')))
1022                         continue;
1023                 if (strlcpy(p, dname, remainder) >= remainder) {
1024                         io_error |= IOERR_GENERAL;
1025                         rprintf(FINFO,
1026                                 "cannot send long-named file %s\n",
1027                                 full_fname(fbuf));
1028                         continue;
1029                 }
1030
1031                 send_file_name(f, flist, fbuf, NULL, 0);
1032         }
1033
1034         fbuf[len] = '\0';
1035
1036         if (errno) {
1037                 io_error |= IOERR_GENERAL;
1038                 rsyserr(FERROR, errno, "readdir(%s)", full_fname(fbuf));
1039         }
1040
1041         closedir(d);
1042
1043         if (recurse) {
1044                 int i, end = flist->count - 1;
1045                 for (i = start; i <= end; i++)
1046                         send_if_directory(f, flist, flist->files[i], fbuf, len);
1047         }
1048 }
1049
1050 struct file_list *send_file_list(int f, int argc, char *argv[])
1051 {
1052         int len;
1053         STRUCT_STAT st;
1054         char *p, *dir, olddir[sizeof curr_dir];
1055         char lastpath[MAXPATHLEN] = "";
1056         struct file_list *flist;
1057         struct timeval start_tv, end_tv;
1058         int64 start_write;
1059         int use_ff_fd = 0;
1060
1061         rprintf(FLOG, "building file list\n");
1062         if (show_filelist_p())
1063                 start_filelist_progress("building file list");
1064
1065         start_write = stats.total_written;
1066         gettimeofday(&start_tv, NULL);
1067
1068         flist = flist_new(WITH_HLINK, "send_file_list");
1069
1070         io_start_buffering_out();
1071         if (filesfrom_fd >= 0) {
1072                 if (sanitize_paths)
1073                         die_on_unsafe_path(argv[0], 0);
1074                 if (argv[0] && !push_dir(argv[0])) {
1075                         rsyserr(FERROR, errno, "push_dir %s failed",
1076                                 full_fname(argv[0]));
1077                         exit_cleanup(RERR_FILESELECT);
1078                 }
1079                 use_ff_fd = 1;
1080         }
1081
1082         while (1) {
1083                 char fbuf[MAXPATHLEN];
1084                 char *fn;
1085                 int is_dot_dir;
1086
1087                 if (use_ff_fd) {
1088                         if (read_filesfrom_line(filesfrom_fd, fbuf) == 0)
1089                                 break;
1090                         sanitize_path(fbuf, fbuf, "", 0, NULL);
1091                 } else {
1092                         if (argc-- == 0)
1093                                 break;
1094                         strlcpy(fbuf, *argv++, MAXPATHLEN);
1095                         if (sanitize_paths)
1096                                 sanitize_path(fbuf, fbuf, "", 0, NULL);
1097                 }
1098
1099                 len = strlen(fbuf);
1100                 if (relative_paths) {
1101                         /* We clean up fbuf below. */
1102                         is_dot_dir = 0;
1103                 } else if (!len || fbuf[len - 1] == '/') {
1104                         if (len == 2 && fbuf[0] == '.') {
1105                                 /* Turn "./" into just "." rather than "./." */
1106                                 fbuf[1] = '\0';
1107                         } else {
1108                                 if (len + 1 >= MAXPATHLEN)
1109                                         overflow_exit("send_file_list");
1110                                 fbuf[len++] = '.';
1111                                 fbuf[len] = '\0';
1112                         }
1113                         is_dot_dir = 1;
1114                 } else if (len > 1 && fbuf[len-1] == '.' && fbuf[len-2] == '.'
1115                     && (len == 2 || fbuf[len-3] == '/')) {
1116                         if (len + 2 >= MAXPATHLEN)
1117                                 overflow_exit("send_file_list");
1118                         fbuf[len++] = '/';
1119                         fbuf[len++] = '.';
1120                         fbuf[len] = '\0';
1121                         is_dot_dir = 1;
1122                 } else {
1123                         is_dot_dir = fbuf[len-1] == '.'
1124                                    && (len == 1 || fbuf[len-2] == '/');
1125                 }
1126
1127                 if (sanitize_paths)
1128                         die_on_unsafe_path(fbuf, 1);
1129                 if (link_stat(fbuf, &st, copy_dirlinks) != 0) {
1130                         io_error |= IOERR_GENERAL;
1131                         rsyserr(FERROR, errno, "link_stat %s failed",
1132                                 full_fname(fbuf));
1133                         continue;
1134                 }
1135
1136                 if (S_ISDIR(st.st_mode) && !xfer_dirs) {
1137                         rprintf(FINFO, "skipping directory %s\n", fbuf);
1138                         continue;
1139                 }
1140
1141                 dir = NULL;
1142                 olddir[0] = '\0';
1143
1144                 if (!relative_paths) {
1145                         p = strrchr(fbuf, '/');
1146                         if (p) {
1147                                 *p = '\0';
1148                                 if (p == fbuf)
1149                                         dir = "/";
1150                                 else
1151                                         dir = fbuf;
1152                                 len -= p - fbuf + 1;
1153                                 fn = p + 1;
1154                         } else
1155                                 fn = fbuf;
1156                 } else {
1157                         if ((p = strstr(fbuf, "/./")) != NULL) {
1158                                 *p = '\0';
1159                                 if (p == fbuf)
1160                                         dir = "/";
1161                                 else
1162                                         dir = fbuf;
1163                                 len -= p - fbuf + 3;
1164                                 fn = p + 3;
1165                         } else
1166                                 fn = fbuf;
1167                         /* Get rid of trailing "/" and "/.". */
1168                         while (len) {
1169                                 if (fn[len - 1] == '/') {
1170                                         is_dot_dir = 1;
1171                                         if (!--len && !dir) {
1172                                                 len++;
1173                                                 break;
1174                                         }
1175                                 }
1176                                 else if (len >= 2 && fn[len - 1] == '.'
1177                                                   && fn[len - 2] == '/') {
1178                                         is_dot_dir = 1;
1179                                         if (!(len -= 2) && !dir) {
1180                                                 len++;
1181                                                 break;
1182                                         }
1183                                 } else
1184                                         break;
1185                         }
1186                         fn[len] = '\0';
1187                         /* Reject a ".." dir in the active part of the path. */
1188                         for (p = fn; (p = strstr(p, "..")) != NULL; p += 2) {
1189                                 if ((p[2] == '/' || p[2] == '\0')
1190                                  && (p == fn || p[-1] == '/')) {
1191                                         rprintf(FERROR,
1192                                             "found \"..\" dir in relative path: %s\n",
1193                                             fbuf);
1194                                         exit_cleanup(RERR_SYNTAX);
1195                                 }
1196                         }
1197                 }
1198
1199                 if (!*fn) {
1200                         len = 1;
1201                         fn = ".";
1202                 }
1203
1204                 if (dir && *dir) {
1205                         static char *lastdir;
1206                         static int lastdir_len;
1207
1208                         strlcpy(olddir, curr_dir, sizeof olddir);
1209
1210                         if (!push_dir(dir)) {
1211                                 io_error |= IOERR_GENERAL;
1212                                 rsyserr(FERROR, errno, "push_dir %s failed",
1213                                         full_fname(dir));
1214                                 continue;
1215                         }
1216
1217                         if (lastdir && strcmp(lastdir, dir) == 0) {
1218                                 flist_dir = lastdir;
1219                                 flist_dir_len = lastdir_len;
1220                         } else {
1221                                 flist_dir = lastdir = strdup(dir);
1222                                 flist_dir_len = lastdir_len = strlen(dir);
1223                         }
1224                 }
1225
1226                 if (fn != fbuf)
1227                         memmove(fbuf, fn, len + 1);
1228
1229                 if (implied_dirs && (p=strrchr(fbuf,'/')) && p != fbuf) {
1230                         /* Send the implied directories at the start of the
1231                          * source spec, so we get their permissions right. */
1232                         char *lp = lastpath, *slash = fbuf;
1233                         *p = '\0';
1234                         /* Skip any initial directories in our path that we
1235                          * have in common with lastpath. */
1236                         for (fn = fbuf; *fn && *lp == *fn; lp++, fn++) {
1237                                 if (*fn == '/')
1238                                         slash = fn;
1239                         }
1240                         *p = '/';
1241                         if (fn != p || (*lp && *lp != '/')) {
1242                                 int save_copy_links = copy_links;
1243                                 int save_xfer_dirs = xfer_dirs;
1244                                 copy_links |= copy_unsafe_links;
1245                                 xfer_dirs = 1;
1246                                 while ((slash = strchr(slash+1, '/')) != 0) {
1247                                         *slash = '\0';
1248                                         send_file_name(f, flist, fbuf, NULL, 0);
1249                                         *slash = '/';
1250                                 }
1251                                 copy_links = save_copy_links;
1252                                 xfer_dirs = save_xfer_dirs;
1253                                 *p = '\0';
1254                                 strlcpy(lastpath, fbuf, sizeof lastpath);
1255                                 *p = '/';
1256                         }
1257                 }
1258
1259                 if (one_file_system)
1260                         filesystem_dev = st.st_dev;
1261
1262                 if (recurse || (xfer_dirs && is_dot_dir)) {
1263                         struct file_struct *file;
1264                         file = send_file_name(f, flist, fbuf, &st, FLAG_TOP_DIR);
1265                         if (file)
1266                                 send_if_directory(f, flist, file, fbuf, len);
1267                 } else
1268                         send_file_name(f, flist, fbuf, &st, 0);
1269
1270                 if (olddir[0]) {
1271                         flist_dir = NULL;
1272                         flist_dir_len = 0;
1273                         if (!pop_dir(olddir)) {
1274                                 rsyserr(FERROR, errno, "pop_dir %s failed",
1275                                         full_fname(olddir));
1276                                 exit_cleanup(RERR_FILESELECT);
1277                         }
1278                 }
1279         }
1280
1281         gettimeofday(&end_tv, NULL);
1282         stats.flist_buildtime = (int64)(end_tv.tv_sec - start_tv.tv_sec) * 1000
1283                               + (end_tv.tv_usec - start_tv.tv_usec) / 1000;
1284         if (stats.flist_buildtime == 0)
1285                 stats.flist_buildtime = 1;
1286         start_tv = end_tv;
1287
1288         send_file_entry(NULL, f);
1289
1290         if (show_filelist_p())
1291                 finish_filelist_progress(flist);
1292
1293         gettimeofday(&end_tv, NULL);
1294         stats.flist_xfertime = (int64)(end_tv.tv_sec - start_tv.tv_sec) * 1000
1295                              + (end_tv.tv_usec - start_tv.tv_usec) / 1000;
1296
1297         if (flist->hlink_pool) {
1298                 pool_destroy(flist->hlink_pool);
1299                 flist->hlink_pool = NULL;
1300         }
1301
1302         /* Sort the list without removing any duplicates.  This allows the
1303          * receiving side to ask for any name they like, which gives us the
1304          * flexibility to change the way we unduplicate names in the future
1305          * without causing a compatibility problem with older versions. */
1306         clean_flist(flist, 0, 0);
1307
1308         send_uid_list(f);
1309
1310         /* send the io_error flag */
1311         write_int(f, lp_ignore_errors(module_id) ? 0 : io_error);
1312
1313         io_end_buffering();
1314         stats.flist_size = stats.total_written - start_write;
1315         stats.num_files = flist->count;
1316
1317         if (verbose > 3)
1318                 output_flist(flist);
1319
1320         if (verbose > 2)
1321                 rprintf(FINFO, "send_file_list done\n");
1322
1323         return flist;
1324 }
1325
1326 struct file_list *recv_file_list(int f)
1327 {
1328         struct file_list *flist;
1329         unsigned short flags;
1330         int64 start_read;
1331
1332         rprintf(FLOG, "receiving file list\n");
1333         if (show_filelist_p())
1334                 start_filelist_progress("receiving file list");
1335
1336         start_read = stats.total_read;
1337
1338         flist = flist_new(WITH_HLINK, "recv_file_list");
1339
1340         flist->count = 0;
1341         flist->malloced = 1000;
1342         flist->files = new_array(struct file_struct *, flist->malloced);
1343         if (!flist->files)
1344                 goto oom;
1345
1346         while ((flags = read_byte(f)) != 0) {
1347                 struct file_struct *file;
1348
1349                 flist_expand(flist);
1350
1351                 if (protocol_version >= 28 && (flags & XMIT_EXTENDED_FLAGS))
1352                         flags |= read_byte(f) << 8;
1353                 file = receive_file_entry(flist, flags, f);
1354
1355                 if (S_ISREG(file->mode) || S_ISLNK(file->mode))
1356                         stats.total_size += file->length;
1357
1358                 flist->files[flist->count++] = file;
1359
1360                 maybe_emit_filelist_progress(flist->count);
1361
1362                 if (verbose > 2) {
1363                         rprintf(FINFO, "recv_file_name(%s)\n",
1364                                 f_name(file, NULL));
1365                 }
1366         }
1367         receive_file_entry(NULL, 0, 0); /* Signal that we're done. */
1368
1369         if (verbose > 2)
1370                 rprintf(FINFO, "received %d names\n", flist->count);
1371
1372         if (show_filelist_p())
1373                 finish_filelist_progress(flist);
1374
1375         clean_flist(flist, relative_paths, 1);
1376
1377         if (f >= 0) {
1378                 recv_uid_list(f, flist);
1379
1380                 /* Recv the io_error flag */
1381                 if (lp_ignore_errors(module_id) || ignore_errors)
1382                         read_int(f);
1383                 else
1384                         io_error |= read_int(f);
1385         }
1386
1387         if (verbose > 3)
1388                 output_flist(flist);
1389
1390         if (list_only) {
1391                 int i;
1392                 for (i = 0; i < flist->count; i++)
1393                         list_file_entry(flist->files[i]);
1394         }
1395
1396         if (verbose > 2)
1397                 rprintf(FINFO, "recv_file_list done\n");
1398
1399         stats.flist_size = stats.total_read - start_read;
1400         stats.num_files = flist->count;
1401
1402         return flist;
1403
1404   oom:
1405         out_of_memory("recv_file_list");
1406         return NULL;            /* not reached */
1407 }
1408
1409 static int file_compare(struct file_struct **file1, struct file_struct **file2)
1410 {
1411         return f_name_cmp(*file1, *file2);
1412 }
1413
1414 /* Search for an identically-named item in the file list.  Note that the
1415  * items must agree in their directory-ness, or no match is returned. */
1416 int flist_find(struct file_list *flist, struct file_struct *f)
1417 {
1418         int low = flist->low, high = flist->high;
1419         int diff, mid, mid_up;
1420
1421         while (low <= high) {
1422                 mid = (low + high) / 2;
1423                 if (flist->files[mid]->basename)
1424                         mid_up = mid;
1425                 else {
1426                         /* Scan for the next non-empty entry using the cached
1427                          * distance values.  If the value isn't fully up-to-
1428                          * date, update it. */
1429                         mid_up = mid + flist->files[mid]->dir.depth;
1430                         if (!flist->files[mid_up]->basename) {
1431                                 do {
1432                                     mid_up += flist->files[mid_up]->dir.depth;
1433                                 } while (!flist->files[mid_up]->basename);
1434                                 flist->files[mid]->dir.depth = mid_up - mid;
1435                         }
1436                         if (mid_up > high) {
1437                                 /* If there's nothing left above us, set high to
1438                                  * a non-empty entry below us and continue. */
1439                                 high = mid - flist->files[mid]->length;
1440                                 if (!flist->files[high]->basename) {
1441                                         do {
1442                                             high -= flist->files[high]->length;
1443                                         } while (!flist->files[high]->basename);
1444                                         flist->files[mid]->length = mid - high;
1445                                 }
1446                                 continue;
1447                         }
1448                 }
1449                 diff = f_name_cmp(flist->files[mid_up], f);
1450                 if (diff == 0) {
1451                         if (protocol_version < 29
1452                             && S_ISDIR(flist->files[mid_up]->mode)
1453                             != S_ISDIR(f->mode))
1454                                 return -1;
1455                         return mid_up;
1456                 }
1457                 if (diff < 0)
1458                         low = mid_up + 1;
1459                 else
1460                         high = mid - 1;
1461         }
1462         return -1;
1463 }
1464
1465 /*
1466  * Free up any resources a file_struct has allocated
1467  * and clear the file.
1468  */
1469 void clear_file(struct file_struct *file, struct file_list *flist)
1470 {
1471         if (flist->hlink_pool && file->link_u.idev)
1472                 pool_free(flist->hlink_pool, 0, file->link_u.idev);
1473         memset(file, 0, file_struct_len);
1474         /* In an empty entry, dir.depth is an offset to the next non-empty
1475          * entry.  Likewise for length in the opposite direction.  We assume
1476          * that we're alone for now since flist_find() will adjust the counts
1477          * it runs into that aren't up-to-date. */
1478         file->length = file->dir.depth = 1;
1479 }
1480
1481 /*
1482  * allocate a new file list
1483  */
1484 struct file_list *flist_new(int with_hlink, char *msg)
1485 {
1486         struct file_list *flist;
1487
1488         flist = new(struct file_list);
1489         if (!flist)
1490                 out_of_memory(msg);
1491
1492         memset(flist, 0, sizeof (struct file_list));
1493
1494         if (!(flist->file_pool = pool_create(FILE_EXTENT, 0,
1495             out_of_memory, POOL_INTERN)))
1496                 out_of_memory(msg);
1497
1498 #ifdef SUPPORT_HARD_LINKS
1499         if (with_hlink && preserve_hard_links) {
1500                 if (!(flist->hlink_pool = pool_create(HLINK_EXTENT,
1501                     sizeof (struct idev), out_of_memory, POOL_INTERN)))
1502                         out_of_memory(msg);
1503         }
1504 #endif
1505
1506         return flist;
1507 }
1508
1509 /*
1510  * free up all elements in a flist
1511  */
1512 void flist_free(struct file_list *flist)
1513 {
1514         pool_destroy(flist->file_pool);
1515         pool_destroy(flist->hlink_pool);
1516         free(flist->files);
1517         free(flist);
1518 }
1519
1520 /*
1521  * This routine ensures we don't have any duplicate names in our file list.
1522  * duplicate names can cause corruption because of the pipelining
1523  */
1524 static void clean_flist(struct file_list *flist, int strip_root, int no_dups)
1525 {
1526         char fbuf[MAXPATHLEN];
1527         int i, prev_i = 0;
1528
1529         if (!flist)
1530                 return;
1531         if (flist->count == 0) {
1532                 flist->high = -1;
1533                 return;
1534         }
1535
1536         qsort(flist->files, flist->count,
1537             sizeof flist->files[0], (int (*)())file_compare);
1538
1539         for (i = no_dups? 0 : flist->count; i < flist->count; i++) {
1540                 if (flist->files[i]->basename) {
1541                         prev_i = i;
1542                         break;
1543                 }
1544         }
1545         flist->low = prev_i;
1546         while (++i < flist->count) {
1547                 int j;
1548                 struct file_struct *file = flist->files[i];
1549
1550                 if (!file->basename)
1551                         continue;
1552                 if (f_name_cmp(file, flist->files[prev_i]) == 0)
1553                         j = prev_i;
1554                 else if (protocol_version >= 29 && S_ISDIR(file->mode)) {
1555                         int save_mode = file->mode;
1556                         /* Make sure that this directory doesn't duplicate a
1557                          * non-directory earlier in the list. */
1558                         flist->high = prev_i;
1559                         file->mode = S_IFREG;
1560                         j = flist_find(flist, file);
1561                         file->mode = save_mode;
1562                 } else
1563                         j = -1;
1564                 if (j >= 0) {
1565                         struct file_struct *fp = flist->files[j];
1566                         int keep, drop;
1567                         /* If one is a dir and the other is not, we want to
1568                          * keep the dir because it might have contents in the
1569                          * list. */
1570                         if (S_ISDIR(file->mode) != S_ISDIR(fp->mode)) {
1571                                 if (S_ISDIR(file->mode))
1572                                         keep = i, drop = j;
1573                                 else
1574                                         keep = j, drop = i;
1575                         } else
1576                                 keep = j, drop = i;
1577                         if (verbose > 1 && !am_server) {
1578                                 rprintf(FINFO,
1579                                         "removing duplicate name %s from file list (%d)\n",
1580                                         f_name(file, fbuf), drop);
1581                         }
1582                         /* Make sure we don't lose track of a user-specified
1583                          * top directory. */
1584                         flist->files[keep]->flags |= flist->files[drop]->flags
1585                                                    & (FLAG_TOP_DIR|FLAG_DEL_HERE);
1586
1587                         clear_file(flist->files[drop], flist);
1588
1589                         if (keep == i) {
1590                                 if (flist->low == drop) {
1591                                         for (j = drop + 1;
1592                                              j < i && !flist->files[j]->basename;
1593                                              j++) {}
1594                                         flist->low = j;
1595                                 }
1596                                 prev_i = i;
1597                         }
1598                 } else
1599                         prev_i = i;
1600         }
1601         flist->high = no_dups ? prev_i : flist->count - 1;
1602
1603         if (strip_root) {
1604                 /* We need to strip off the leading slashes for relative
1605                  * paths, but this must be done _after_ the sorting phase. */
1606                 for (i = flist->low; i <= flist->high; i++) {
1607                         struct file_struct *file = flist->files[i];
1608
1609                         if (!file->dirname)
1610                                 continue;
1611                         while (*file->dirname == '/')
1612                                 file->dirname++;
1613                         if (!*file->dirname)
1614                                 file->dirname = NULL;
1615                 }
1616         }
1617
1618         if (prune_empty_dirs && no_dups) {
1619                 int j, prev_depth = 0;
1620
1621                 prev_i = 0; /* It's OK that this isn't really true. */
1622
1623                 for (i = flist->low; i <= flist->high; i++) {
1624                         struct file_struct *fp, *file = flist->files[i];
1625
1626                         /* This temporarily abuses the dir.depth value for a
1627                          * directory that is in a chain that might get pruned.
1628                          * We restore the old value if it gets a reprieve. */
1629                         if (S_ISDIR(file->mode) && file->dir.depth) {
1630                                 /* Dump empty dirs when coming back down. */
1631                                 for (j = prev_depth; j >= file->dir.depth; j--) {
1632                                         fp = flist->files[prev_i];
1633                                         if (fp->dir.depth >= 0)
1634                                                 break;
1635                                         prev_i = -fp->dir.depth-1;
1636                                         clear_file(fp, flist);
1637                                 }
1638                                 prev_depth = file->dir.depth;
1639                                 if (is_excluded(f_name(file, fbuf), 1,
1640                                                        ALL_FILTERS)) {
1641                                         /* Keep dirs through this dir. */
1642                                         for (j = prev_depth-1; ; j--) {
1643                                                 fp = flist->files[prev_i];
1644                                                 if (fp->dir.depth >= 0)
1645                                                         break;
1646                                                 prev_i = -fp->dir.depth-1;
1647                                                 fp->dir.depth = j;
1648                                         }
1649                                 } else
1650                                         file->dir.depth = -prev_i-1;
1651                                 prev_i = i;
1652                         } else {
1653                                 /* Keep dirs through this non-dir. */
1654                                 for (j = prev_depth; ; j--) {
1655                                         fp = flist->files[prev_i];
1656                                         if (fp->dir.depth >= 0)
1657                                                 break;
1658                                         prev_i = -fp->dir.depth-1;
1659                                         fp->dir.depth = j;
1660                                 }
1661                         }
1662                 }
1663                 /* Dump empty all remaining empty dirs. */
1664                 while (1) {
1665                         struct file_struct *fp = flist->files[prev_i];
1666                         if (fp->dir.depth >= 0)
1667                                 break;
1668                         prev_i = -fp->dir.depth-1;
1669                         clear_file(fp, flist);
1670                 }
1671
1672                 for (i = flist->low; i <= flist->high; i++) {
1673                         if (flist->files[i]->basename)
1674                                 break;
1675                 }
1676                 flist->low = i;
1677                 for (i = flist->high; i >= flist->low; i--) {
1678                         if (flist->files[i]->basename)
1679                                 break;
1680                 }
1681                 flist->high = i;
1682         }
1683 }
1684
1685 static void output_flist(struct file_list *flist)
1686 {
1687         char uidbuf[16], gidbuf[16], depthbuf[16];
1688         struct file_struct *file;
1689         const char *who = who_am_i();
1690         int i;
1691
1692         for (i = 0; i < flist->count; i++) {
1693                 file = flist->files[i];
1694                 if ((am_root || am_sender) && preserve_uid)
1695                         sprintf(uidbuf, " uid=%ld", (long)file->uid);
1696                 else
1697                         *uidbuf = '\0';
1698                 if (preserve_gid && file->gid != GID_NONE)
1699                         sprintf(gidbuf, " gid=%ld", (long)file->gid);
1700                 else
1701                         *gidbuf = '\0';
1702                 if (!am_sender)
1703                         sprintf(depthbuf, "%d", file->dir.depth);
1704                 rprintf(FINFO, "[%s] i=%d %s %s%s%s%s mode=0%o len=%.0f%s%s flags=%x\n",
1705                         who, i, am_sender ? NS(file->dir.root) : depthbuf,
1706                         file->dirname ? file->dirname : "",
1707                         file->dirname ? "/" : "", NS(file->basename),
1708                         S_ISDIR(file->mode) ? "/" : "", (int)file->mode,
1709                         (double)file->length, uidbuf, gidbuf, file->flags);
1710         }
1711 }
1712
1713 enum fnc_state { s_DIR, s_SLASH, s_BASE, s_TRAILING };
1714 enum fnc_type { t_PATH, t_ITEM };
1715
1716 /* Compare the names of two file_struct entities, similar to how strcmp()
1717  * would do if it were operating on the joined strings.
1718  *
1719  * Some differences beginning with protocol_version 29: (1) directory names
1720  * are compared with an assumed trailing slash so that they compare in a
1721  * way that would cause them to sort immediately prior to any content they
1722  * may have; (2) a directory of any name compares after a non-directory of
1723  * any name at the same depth; (3) a directory with name "." compares prior
1724  * to anything else.  These changes mean that a directory and a non-dir
1725  * with the same name will not compare as equal (protocol_version >= 29).
1726  *
1727  * The dirname component can be an empty string, but the basename component
1728  * cannot (and never is in the current codebase).  The basename component
1729  * may be NULL (for a removed item), in which case it is considered to be
1730  * after any existing item. */
1731 int f_name_cmp(struct file_struct *f1, struct file_struct *f2)
1732 {
1733         int dif;
1734         const uchar *c1, *c2;
1735         enum fnc_state state1, state2;
1736         enum fnc_type type1, type2;
1737         enum fnc_type t_path = protocol_version >= 29 ? t_PATH : t_ITEM;
1738
1739         if (!f1 || !f1->basename) {
1740                 if (!f2 || !f2->basename)
1741                         return 0;
1742                 return -1;
1743         }
1744         if (!f2 || !f2->basename)
1745                 return 1;
1746
1747         c1 = (uchar*)f1->dirname;
1748         c2 = (uchar*)f2->dirname;
1749         if (c1 == c2)
1750                 c1 = c2 = NULL;
1751         if (!c1) {
1752                 type1 = S_ISDIR(f1->mode) ? t_path : t_ITEM;
1753                 c1 = (uchar*)f1->basename;
1754                 if (type1 == t_PATH && *c1 == '.' && !c1[1]) {
1755                         type1 = t_ITEM;
1756                         state1 = s_TRAILING;
1757                         c1 = (uchar*)"";
1758                 } else
1759                         state1 = s_BASE;
1760         } else if (!*c1) {
1761                 type1 = t_path;
1762                 state1 = s_SLASH;
1763                 c1 = (uchar*)"/";
1764         } else {
1765                 type1 = t_path;
1766                 state1 = s_DIR;
1767         }
1768         if (!c2) {
1769                 type2 = S_ISDIR(f2->mode) ? t_path : t_ITEM;
1770                 c2 = (uchar*)f2->basename;
1771                 if (type2 == t_PATH && *c2 == '.' && !c2[1]) {
1772                         type2 = t_ITEM;
1773                         state2 = s_TRAILING;
1774                         c2 = (uchar*)"";
1775                 } else
1776                         state2 = s_BASE;
1777         } else if (!*c2) {
1778                 type2 = t_path;
1779                 state2 = s_SLASH;
1780                 c2 = (uchar*)"/";
1781         } else {
1782                 type2 = t_path;
1783                 state2 = s_DIR;
1784         }
1785
1786         if (type1 != type2)
1787                 return type1 == t_PATH ? 1 : -1;
1788
1789         while (1) {
1790                 if ((dif = (int)*c1++ - (int)*c2++) != 0)
1791                         break;
1792                 if (!*c1) {
1793                         switch (state1) {
1794                         case s_DIR:
1795                                 state1 = s_SLASH;
1796                                 c1 = (uchar*)"/";
1797                                 break;
1798                         case s_SLASH:
1799                                 type1 = S_ISDIR(f1->mode) ? t_path : t_ITEM;
1800                                 c1 = (uchar*)f1->basename;
1801                                 if (type1 == t_PATH && *c1 == '.' && !c1[1]) {
1802                                         type1 = t_ITEM;
1803                                         state1 = s_TRAILING;
1804                                         c1 = (uchar*)"";
1805                                 } else
1806                                         state1 = s_BASE;
1807                                 break;
1808                         case s_BASE:
1809                                 state1 = s_TRAILING;
1810                                 if (type1 == t_PATH) {
1811                                         c1 = (uchar*)"/";
1812                                         break;
1813                                 }
1814                                 /* FALL THROUGH */
1815                         case s_TRAILING:
1816                                 type1 = t_ITEM;
1817                                 break;
1818                         }
1819                         if (*c2 && type1 != type2)
1820                                 return type1 == t_PATH ? 1 : -1;
1821                 }
1822                 if (!*c2) {
1823                         switch (state2) {
1824                         case s_DIR:
1825                                 state2 = s_SLASH;
1826                                 c2 = (uchar*)"/";
1827                                 break;
1828                         case s_SLASH:
1829                                 type2 = S_ISDIR(f2->mode) ? t_path : t_ITEM;
1830                                 c2 = (uchar*)f2->basename;
1831                                 if (type2 == t_PATH && *c2 == '.' && !c2[1]) {
1832                                         type2 = t_ITEM;
1833                                         state2 = s_TRAILING;
1834                                         c2 = (uchar*)"";
1835                                 } else
1836                                         state2 = s_BASE;
1837                                 break;
1838                         case s_BASE:
1839                                 state2 = s_TRAILING;
1840                                 if (type2 == t_PATH) {
1841                                         c2 = (uchar*)"/";
1842                                         break;
1843                                 }
1844                                 /* FALL THROUGH */
1845                         case s_TRAILING:
1846                                 if (!*c1)
1847                                         return 0;
1848                                 type2 = t_ITEM;
1849                                 break;
1850                         }
1851                         if (type1 != type2)
1852                                 return type1 == t_PATH ? 1 : -1;
1853                 }
1854         }
1855
1856         return dif;
1857 }
1858
1859 /* Return a copy of the full filename of a flist entry, using the indicated
1860  * buffer or one of 5 static buffers if fbuf is NULL.  No size-checking is
1861  * done because we checked the size when creating the file_struct entry.
1862  */
1863 char *f_name(struct file_struct *f, char *fbuf)
1864 {
1865         if (!f || !f->basename)
1866                 return NULL;
1867
1868         if (!fbuf) {
1869                 static char names[5][MAXPATHLEN];
1870                 static unsigned int n;
1871
1872                 n = (n + 1) % (sizeof names / sizeof names[0]);
1873
1874                 fbuf = names[n];
1875         }
1876
1877         if (f->dirname) {
1878                 int len = strlen(f->dirname);
1879                 memcpy(fbuf, f->dirname, len);
1880                 fbuf[len] = '/';
1881                 strcpy(fbuf + len + 1, f->basename);
1882         } else
1883                 strcpy(fbuf, f->basename);
1884
1885         return fbuf;
1886 }
1887
1888 /* Do a non-recursive scan of the named directory, possibly ignoring all
1889  * exclude rules except for the daemon's.  If "dlen" is >=0, it is the length
1890  * of the dirname string, and also indicates that "dirname" is a MAXPATHLEN
1891  * buffer (the functions we call will append names onto the end, but the old
1892  * dir value will be restored on exit). */
1893 struct file_list *get_dirlist(char *dirname, int dlen,
1894                               int ignore_filter_rules)
1895 {
1896         struct file_list *dirlist;
1897         char dirbuf[MAXPATHLEN];
1898         int save_recurse = recurse;
1899         int save_xfer_dirs = xfer_dirs;
1900
1901         if (dlen < 0) {
1902                 dlen = strlcpy(dirbuf, dirname, MAXPATHLEN);
1903                 if (dlen >= MAXPATHLEN)
1904                         return NULL;
1905                 dirname = dirbuf;
1906         }
1907
1908         dirlist = flist_new(WITHOUT_HLINK, "get_dirlist");
1909
1910         recurse = 0;
1911         xfer_dirs = 1;
1912         send_directory(ignore_filter_rules ? -2 : -1, dirlist, dirname, dlen);
1913         xfer_dirs = save_xfer_dirs;
1914         recurse = save_recurse;
1915         if (do_progress)
1916                 flist_count_offset += dirlist->count;
1917
1918         clean_flist(dirlist, 0, 0);
1919
1920         if (verbose > 3)
1921                 output_flist(dirlist);
1922
1923         return dirlist;
1924 }