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