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