More archaic-checksum improvements. This makes the len vars clearer
[rsync.git] / util.c
1 /*
2  * Utility routines used in rsync.
3  *
4  * Copyright (C) 1996-2000 Andrew Tridgell
5  * Copyright (C) 1996 Paul Mackerras
6  * Copyright (C) 2001, 2002 Martin Pool <mbp@samba.org>
7  * Copyright (C) 2003-2015 Wayne Davison
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License along
20  * with this program; if not, visit the http://fsf.org website.
21  */
22
23 #include "rsync.h"
24 #include "ifuncs.h"
25 #include "itypes.h"
26 #include "inums.h"
27
28 extern int dry_run;
29 extern int module_id;
30 extern int protect_args;
31 extern int modify_window;
32 extern int relative_paths;
33 extern int preserve_times;
34 extern int preserve_xattrs;
35 extern int preallocate_files;
36 extern char *module_dir;
37 extern unsigned int module_dirlen;
38 extern char *partial_dir;
39 extern filter_rule_list daemon_filter_list;
40
41 int sanitize_paths = 0;
42
43 char curr_dir[MAXPATHLEN];
44 unsigned int curr_dir_len;
45 int curr_dir_depth; /* This is only set for a sanitizing daemon. */
46
47 /* Set a fd into nonblocking mode. */
48 void set_nonblocking(int fd)
49 {
50         int val;
51
52         if ((val = fcntl(fd, F_GETFL)) == -1)
53                 return;
54         if (!(val & NONBLOCK_FLAG)) {
55                 val |= NONBLOCK_FLAG;
56                 fcntl(fd, F_SETFL, val);
57         }
58 }
59
60 /* Set a fd into blocking mode. */
61 void set_blocking(int fd)
62 {
63         int val;
64
65         if ((val = fcntl(fd, F_GETFL)) == -1)
66                 return;
67         if (val & NONBLOCK_FLAG) {
68                 val &= ~NONBLOCK_FLAG;
69                 fcntl(fd, F_SETFL, val);
70         }
71 }
72
73 /**
74  * Create a file descriptor pair - like pipe() but use socketpair if
75  * possible (because of blocking issues on pipes).
76  *
77  * Always set non-blocking.
78  */
79 int fd_pair(int fd[2])
80 {
81         int ret;
82
83 #ifdef HAVE_SOCKETPAIR
84         ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
85 #else
86         ret = pipe(fd);
87 #endif
88
89         if (ret == 0) {
90                 set_nonblocking(fd[0]);
91                 set_nonblocking(fd[1]);
92         }
93
94         return ret;
95 }
96
97 void print_child_argv(const char *prefix, char **cmd)
98 {
99         int cnt = 0;
100         rprintf(FCLIENT, "%s ", prefix);
101         for (; *cmd; cmd++) {
102                 /* Look for characters that ought to be quoted.  This
103                 * is not a great quoting algorithm, but it's
104                 * sufficient for a log message. */
105                 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
106                            "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
107                            "0123456789"
108                            ",.-_=+@/") != strlen(*cmd)) {
109                         rprintf(FCLIENT, "\"%s\" ", *cmd);
110                 } else {
111                         rprintf(FCLIENT, "%s ", *cmd);
112                 }
113                 cnt++;
114         }
115         rprintf(FCLIENT, " (%d args)\n", cnt);
116 }
117
118 /* This returns 0 for success, 1 for a symlink if symlink time-setting
119  * is not possible, or -1 for any other error. */
120 int set_modtime(const char *fname, time_t modtime, uint32 mod_nsec, mode_t mode)
121 {
122         static int switch_step = 0;
123
124         if (DEBUG_GTE(TIME, 1)) {
125                 rprintf(FINFO, "set modtime of %s to (%ld) %s",
126                         fname, (long)modtime,
127                         asctime(localtime(&modtime)));
128         }
129
130         switch (switch_step) {
131 #ifdef HAVE_SETATTRLIST
132 #include "case_N.h"
133                 if (do_setattrlist_times(fname, modtime, mod_nsec) == 0)
134                         break;
135                 if (errno != ENOSYS)
136                         return -1;
137                 switch_step++;
138                 /* FALLTHROUGH */
139 #endif
140
141 #ifdef HAVE_UTIMENSAT
142 #include "case_N.h"
143                 if (do_utimensat(fname, modtime, mod_nsec) == 0)
144                         break;
145                 if (errno != ENOSYS)
146                         return -1;
147                 switch_step++;
148                 /* FALLTHROUGH */
149 #endif
150
151 #ifdef HAVE_LUTIMES
152 #include "case_N.h"
153                 if (do_lutimes(fname, modtime, mod_nsec) == 0)
154                         break;
155                 if (errno != ENOSYS)
156                         return -1;
157                 switch_step++;
158                 /* FALLTHROUGH */
159 #endif
160
161 #include "case_N.h"
162                 switch_step++;
163                 if (preserve_times & PRESERVE_LINK_TIMES) {
164                         preserve_times &= ~PRESERVE_LINK_TIMES;
165                         if (S_ISLNK(mode))
166                                 return 1;
167                 }
168                 /* FALLTHROUGH */
169
170 #include "case_N.h"
171 #ifdef HAVE_UTIMES
172                 if (do_utimes(fname, modtime, mod_nsec) == 0)
173                         break;
174 #else
175                 if (do_utime(fname, modtime, mod_nsec) == 0)
176                         break;
177 #endif
178
179                 return -1;
180         }
181
182         return 0;
183 }
184
185 /* Create any necessary directories in fname.  Any missing directories are
186  * created with default permissions.  Returns < 0 on error, or the number
187  * of directories created. */
188 int make_path(char *fname, int flags)
189 {
190         char *end, *p;
191         int ret = 0;
192
193         if (flags & MKP_SKIP_SLASH) {
194                 while (*fname == '/')
195                         fname++;
196         }
197
198         while (*fname == '.' && fname[1] == '/')
199                 fname += 2;
200
201         if (flags & MKP_DROP_NAME) {
202                 end = strrchr(fname, '/');
203                 if (!end || end == fname)
204                         return 0;
205                 *end = '\0';
206         } else
207                 end = fname + strlen(fname);
208
209         /* Try to find an existing dir, starting from the deepest dir. */
210         for (p = end; ; ) {
211                 if (dry_run) {
212                         STRUCT_STAT st;
213                         if (do_stat(fname, &st) == 0) {
214                                 if (S_ISDIR(st.st_mode))
215                                         errno = EEXIST;
216                                 else
217                                         errno = ENOTDIR;
218                         }
219                 } else if (do_mkdir(fname, ACCESSPERMS) == 0) {
220                         ret++;
221                         break;
222                 }
223
224                 if (errno != ENOENT) {
225                         STRUCT_STAT st;
226                         if (errno != EEXIST || (do_stat(fname, &st) == 0 && !S_ISDIR(st.st_mode)))
227                                 ret = -ret - 1;
228                         break;
229                 }
230                 while (1) {
231                         if (p == fname) {
232                                 /* We got a relative path that doesn't exist, so assume that '.'
233                                  * is there and just break out and create the whole thing. */
234                                 p = NULL;
235                                 goto double_break;
236                         }
237                         if (*--p == '/') {
238                                 if (p == fname) {
239                                         /* We reached the "/" dir, which we assume is there. */
240                                         goto double_break;
241                                 }
242                                 *p = '\0';
243                                 break;
244                         }
245                 }
246         }
247   double_break:
248
249         /* Make all the dirs that we didn't find on the way here. */
250         while (p != end) {
251                 if (p)
252                         *p = '/';
253                 else
254                         p = fname;
255                 p += strlen(p);
256                 if (ret < 0) /* Skip mkdir on error, but keep restoring the path. */
257                         continue;
258                 if (do_mkdir(fname, ACCESSPERMS) < 0)
259                         ret = -ret - 1;
260                 else
261                         ret++;
262         }
263
264         if (flags & MKP_DROP_NAME)
265                 *end = '/';
266
267         return ret;
268 }
269
270 /**
271  * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
272  * interrupted.
273  *
274  * @retval len upon success
275  *
276  * @retval <0 write's (negative) error code
277  *
278  * Derived from GNU C's cccp.c.
279  */
280 int full_write(int desc, const char *ptr, size_t len)
281 {
282         int total_written;
283
284         total_written = 0;
285         while (len > 0) {
286                 int written = write(desc, ptr, len);
287                 if (written < 0)  {
288                         if (errno == EINTR)
289                                 continue;
290                         return written;
291                 }
292                 total_written += written;
293                 ptr += written;
294                 len -= written;
295         }
296         return total_written;
297 }
298
299 /**
300  * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
301  * interrupted.
302  *
303  * @retval >0 the actual number of bytes read
304  *
305  * @retval 0 for EOF
306  *
307  * @retval <0 for an error.
308  *
309  * Derived from GNU C's cccp.c. */
310 static int safe_read(int desc, char *ptr, size_t len)
311 {
312         int n_chars;
313
314         if (len == 0)
315                 return len;
316
317         do {
318                 n_chars = read(desc, ptr, len);
319         } while (n_chars < 0 && errno == EINTR);
320
321         return n_chars;
322 }
323
324 /* Copy a file.  If ofd < 0, copy_file unlinks and opens the "dest" file.
325  * Otherwise, it just writes to and closes the provided file descriptor.
326  * In either case, if --xattrs are being preserved, the dest file will
327  * have its xattrs set from the source file.
328  *
329  * This is used in conjunction with the --temp-dir, --backup, and
330  * --copy-dest options. */
331 int copy_file(const char *source, const char *dest, int ofd, mode_t mode)
332 {
333         int ifd;
334         char buf[1024 * 8];
335         int len;   /* Number of bytes read into `buf'. */
336         OFF_T prealloc_len = 0, offset = 0;
337
338         if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
339                 int save_errno = errno;
340                 rsyserr(FERROR_XFER, errno, "open %s", full_fname(source));
341                 errno = save_errno;
342                 return -1;
343         }
344
345         if (ofd < 0) {
346                 if (robust_unlink(dest) && errno != ENOENT) {
347                         int save_errno = errno;
348                         rsyserr(FERROR_XFER, errno, "unlink %s", full_fname(dest));
349                         errno = save_errno;
350                         return -1;
351                 }
352
353 #ifdef SUPPORT_XATTRS
354                 if (preserve_xattrs)
355                         mode |= S_IWUSR;
356 #endif
357                 mode &= INITACCESSPERMS;
358                 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0) {
359                         int save_errno = errno;
360                         rsyserr(FERROR_XFER, save_errno, "open %s", full_fname(dest));
361                         close(ifd);
362                         errno = save_errno;
363                         return -1;
364                 }
365         }
366
367 #ifdef SUPPORT_PREALLOCATION
368         if (preallocate_files) {
369                 STRUCT_STAT srcst;
370
371                 /* Try to preallocate enough space for file's eventual length.  Can
372                  * reduce fragmentation on filesystems like ext4, xfs, and NTFS. */
373                 if (do_fstat(ifd, &srcst) < 0)
374                         rsyserr(FWARNING, errno, "fstat %s", full_fname(source));
375                 else if (srcst.st_size > 0) {
376                         prealloc_len = do_fallocate(ofd, 0, srcst.st_size);
377                         if (prealloc_len < 0)
378                                 rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(dest));
379                 }
380         }
381 #endif
382
383         while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
384                 if (full_write(ofd, buf, len) < 0) {
385                         int save_errno = errno;
386                         rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
387                         close(ifd);
388                         close(ofd);
389                         errno = save_errno;
390                         return -1;
391                 }
392                 offset += len;
393         }
394
395         if (len < 0) {
396                 int save_errno = errno;
397                 rsyserr(FERROR_XFER, errno, "read %s", full_fname(source));
398                 close(ifd);
399                 close(ofd);
400                 errno = save_errno;
401                 return -1;
402         }
403
404         if (close(ifd) < 0) {
405                 rsyserr(FWARNING, errno, "close failed on %s",
406                         full_fname(source));
407         }
408
409         /* Source file might have shrunk since we fstatted it.
410          * Cut off any extra preallocated zeros from dest file. */
411         if (offset < prealloc_len && do_ftruncate(ofd, offset) < 0) {
412                 /* If we fail to truncate, the dest file may be wrong, so we
413                  * must trigger the "partial transfer" error. */
414                 rsyserr(FERROR_XFER, errno, "ftruncate %s", full_fname(dest));
415         }
416
417         if (close(ofd) < 0) {
418                 int save_errno = errno;
419                 rsyserr(FERROR_XFER, errno, "close failed on %s",
420                         full_fname(dest));
421                 errno = save_errno;
422                 return -1;
423         }
424
425 #ifdef SUPPORT_XATTRS
426         if (preserve_xattrs)
427                 copy_xattrs(source, dest);
428 #endif
429
430         return 0;
431 }
432
433 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
434 #define MAX_RENAMES_DIGITS 3
435 #define MAX_RENAMES 1000
436
437 /**
438  * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
439  * rename to <path>/.rsyncNNN instead.
440  *
441  * Note that successive rsync runs will shuffle the filenames around a
442  * bit as long as the file is still busy; this is because this function
443  * does not know if the unlink call is due to a new file coming in, or
444  * --delete trying to remove old .rsyncNNN files, hence it renames it
445  * each time.
446  **/
447 int robust_unlink(const char *fname)
448 {
449 #ifndef ETXTBSY
450         return do_unlink(fname);
451 #else
452         static int counter = 1;
453         int rc, pos, start;
454         char path[MAXPATHLEN];
455
456         rc = do_unlink(fname);
457         if (rc == 0 || errno != ETXTBSY)
458                 return rc;
459
460         if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
461                 pos = MAXPATHLEN - 1;
462
463         while (pos > 0 && path[pos-1] != '/')
464                 pos--;
465         pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
466
467         if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
468                 errno = ETXTBSY;
469                 return -1;
470         }
471
472         /* start where the last one left off to reduce chance of clashes */
473         start = counter;
474         do {
475                 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
476                 if (++counter >= MAX_RENAMES)
477                         counter = 1;
478         } while ((rc = access(path, 0)) == 0 && counter != start);
479
480         if (INFO_GTE(MISC, 1)) {
481                 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
482                         fname, path);
483         }
484
485         /* maybe we should return rename()'s exit status? Nah. */
486         if (do_rename(fname, path) != 0) {
487                 errno = ETXTBSY;
488                 return -1;
489         }
490         return 0;
491 #endif
492 }
493
494 /* Returns 0 on successful rename, 1 if we successfully copied the file
495  * across filesystems, -2 if copy_file() failed, and -1 on other errors.
496  * If partialptr is not NULL and we need to do a copy, copy the file into
497  * the active partial-dir instead of over the destination file. */
498 int robust_rename(const char *from, const char *to, const char *partialptr,
499                   int mode)
500 {
501         int tries = 4;
502
503         while (tries--) {
504                 if (do_rename(from, to) == 0)
505                         return 0;
506
507                 switch (errno) {
508 #ifdef ETXTBSY
509                 case ETXTBSY:
510                         if (robust_unlink(to) != 0) {
511                                 errno = ETXTBSY;
512                                 return -1;
513                         }
514                         errno = ETXTBSY;
515                         break;
516 #endif
517                 case EXDEV:
518                         if (partialptr) {
519                                 if (!handle_partial_dir(partialptr,PDIR_CREATE))
520                                         return -2;
521                                 to = partialptr;
522                         }
523                         if (copy_file(from, to, -1, mode) != 0)
524                                 return -2;
525                         do_unlink(from);
526                         return 1;
527                 default:
528                         return -1;
529                 }
530         }
531         return -1;
532 }
533
534 static pid_t all_pids[10];
535 static int num_pids;
536
537 /** Fork and record the pid of the child. **/
538 pid_t do_fork(void)
539 {
540         pid_t newpid = fork();
541
542         if (newpid != 0  &&  newpid != -1) {
543                 all_pids[num_pids++] = newpid;
544         }
545         return newpid;
546 }
547
548 /**
549  * Kill all children.
550  *
551  * @todo It would be kind of nice to make sure that they are actually
552  * all our children before we kill them, because their pids may have
553  * been recycled by some other process.  Perhaps when we wait for a
554  * child, we should remove it from this array.  Alternatively we could
555  * perhaps use process groups, but I think that would not work on
556  * ancient Unix versions that don't support them.
557  **/
558 void kill_all(int sig)
559 {
560         int i;
561
562         for (i = 0; i < num_pids; i++) {
563                 /* Let's just be a little careful where we
564                  * point that gun, hey?  See kill(2) for the
565                  * magic caused by negative values. */
566                 pid_t p = all_pids[i];
567
568                 if (p == getpid())
569                         continue;
570                 if (p <= 0)
571                         continue;
572
573                 kill(p, sig);
574         }
575 }
576
577 /** Lock a byte range in a open file */
578 int lock_range(int fd, int offset, int len)
579 {
580         struct flock lock;
581
582         lock.l_type = F_WRLCK;
583         lock.l_whence = SEEK_SET;
584         lock.l_start = offset;
585         lock.l_len = len;
586         lock.l_pid = 0;
587
588         return fcntl(fd,F_SETLK,&lock) == 0;
589 }
590
591 #define ENSURE_MEMSPACE(buf, type, sz, req) \
592         if ((req) > sz && !(buf = realloc_array(buf, type, sz = MAX(sz * 2, req)))) \
593                 out_of_memory("glob_expand")
594
595 static inline void call_glob_match(const char *name, int len, int from_glob,
596                                    char *arg, int abpos, int fbpos);
597
598 static struct glob_data {
599         char *arg_buf, *filt_buf, **argv;
600         int absize, fbsize, maxargs, argc;
601 } glob;
602
603 static void glob_match(char *arg, int abpos, int fbpos)
604 {
605         int len;
606         char *slash;
607
608         while (*arg == '.' && arg[1] == '/') {
609                 if (fbpos < 0) {
610                         ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, glob.absize);
611                         memcpy(glob.filt_buf, glob.arg_buf, abpos + 1);
612                         fbpos = abpos;
613                 }
614                 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + 3);
615                 glob.arg_buf[abpos++] = *arg++;
616                 glob.arg_buf[abpos++] = *arg++;
617                 glob.arg_buf[abpos] = '\0';
618         }
619         if ((slash = strchr(arg, '/')) != NULL) {
620                 *slash = '\0';
621                 len = slash - arg;
622         } else
623                 len = strlen(arg);
624         if (strpbrk(arg, "*?[")) {
625                 struct dirent *di;
626                 DIR *d;
627
628                 if (!(d = opendir(abpos ? glob.arg_buf : ".")))
629                         return;
630                 while ((di = readdir(d)) != NULL) {
631                         char *dname = d_name(di);
632                         if (dname[0] == '.' && (dname[1] == '\0'
633                           || (dname[1] == '.' && dname[2] == '\0')))
634                                 continue;
635                         if (!wildmatch(arg, dname))
636                                 continue;
637                         call_glob_match(dname, strlen(dname), 1,
638                                         slash ? arg + len + 1 : NULL,
639                                         abpos, fbpos);
640                 }
641                 closedir(d);
642         } else {
643                 call_glob_match(arg, len, 0,
644                                 slash ? arg + len + 1 : NULL,
645                                 abpos, fbpos);
646         }
647         if (slash)
648                 *slash = '/';
649 }
650
651 static inline void call_glob_match(const char *name, int len, int from_glob,
652                                    char *arg, int abpos, int fbpos)
653 {
654         char *use_buf;
655
656         ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + len + 2);
657         memcpy(glob.arg_buf + abpos, name, len);
658         abpos += len;
659         glob.arg_buf[abpos] = '\0';
660
661         if (fbpos >= 0) {
662                 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, fbpos + len + 2);
663                 memcpy(glob.filt_buf + fbpos, name, len);
664                 fbpos += len;
665                 glob.filt_buf[fbpos] = '\0';
666                 use_buf = glob.filt_buf;
667         } else
668                 use_buf = glob.arg_buf;
669
670         if (from_glob || (arg && len)) {
671                 STRUCT_STAT st;
672                 int is_dir;
673
674                 if (do_stat(glob.arg_buf, &st) != 0)
675                         return;
676                 is_dir = S_ISDIR(st.st_mode) != 0;
677                 if (arg && !is_dir)
678                         return;
679
680                 if (daemon_filter_list.head
681                  && check_filter(&daemon_filter_list, FLOG, use_buf, is_dir) < 0)
682                         return;
683         }
684
685         if (arg) {
686                 glob.arg_buf[abpos++] = '/';
687                 glob.arg_buf[abpos] = '\0';
688                 if (fbpos >= 0) {
689                         glob.filt_buf[fbpos++] = '/';
690                         glob.filt_buf[fbpos] = '\0';
691                 }
692                 glob_match(arg, abpos, fbpos);
693         } else {
694                 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
695                 if (!(glob.argv[glob.argc++] = strdup(glob.arg_buf)))
696                         out_of_memory("glob_match");
697         }
698 }
699
700 /* This routine performs wild-card expansion of the pathname in "arg".  Any
701  * daemon-excluded files/dirs will not be matched by the wildcards.  Returns 0
702  * if a wild-card string is the only returned item (due to matching nothing). */
703 int glob_expand(const char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
704 {
705         int ret, save_argc;
706         char *s;
707
708         if (!arg) {
709                 if (glob.filt_buf)
710                         free(glob.filt_buf);
711                 free(glob.arg_buf);
712                 memset(&glob, 0, sizeof glob);
713                 return -1;
714         }
715
716         if (sanitize_paths)
717                 s = sanitize_path(NULL, arg, "", 0, SP_KEEP_DOT_DIRS);
718         else {
719                 s = strdup(arg);
720                 if (!s)
721                         out_of_memory("glob_expand");
722                 clean_fname(s, CFN_KEEP_DOT_DIRS
723                              | CFN_KEEP_TRAILING_SLASH
724                              | CFN_COLLAPSE_DOT_DOT_DIRS);
725         }
726
727         ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, MAXPATHLEN);
728         *glob.arg_buf = '\0';
729
730         glob.argc = save_argc = *argc_p;
731         glob.argv = *argv_p;
732         glob.maxargs = *maxargs_p;
733
734         ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, 100);
735
736         glob_match(s, 0, -1);
737
738         /* The arg didn't match anything, so add the failed arg to the list. */
739         if (glob.argc == save_argc) {
740                 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
741                 glob.argv[glob.argc++] = s;
742                 ret = 0;
743         } else {
744                 free(s);
745                 ret = 1;
746         }
747
748         *maxargs_p = glob.maxargs;
749         *argv_p = glob.argv;
750         *argc_p = glob.argc;
751
752         return ret;
753 }
754
755 /* This routine is only used in daemon mode. */
756 void glob_expand_module(char *base1, char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
757 {
758         char *p, *s;
759         char *base = base1;
760         int base_len = strlen(base);
761
762         if (!arg || !*arg)
763                 return;
764
765         if (strncmp(arg, base, base_len) == 0)
766                 arg += base_len;
767
768         if (protect_args) {
769                 glob_expand(arg, argv_p, argc_p, maxargs_p);
770                 return;
771         }
772
773         if (!(arg = strdup(arg)))
774                 out_of_memory("glob_expand_module");
775
776         if (asprintf(&base," %s/", base1) < 0)
777                 out_of_memory("glob_expand_module");
778         base_len++;
779
780         for (s = arg; *s; s = p + base_len) {
781                 if ((p = strstr(s, base)) != NULL)
782                         *p = '\0'; /* split it at this point */
783                 glob_expand(s, argv_p, argc_p, maxargs_p);
784                 if (!p)
785                         break;
786         }
787
788         free(arg);
789         free(base);
790 }
791
792 /**
793  * Convert a string to lower case
794  **/
795 void strlower(char *s)
796 {
797         while (*s) {
798                 if (isUpper(s))
799                         *s = toLower(s);
800                 s++;
801         }
802 }
803
804 /**
805  * Split a string into tokens based (usually) on whitespace & commas.  If the
806  * string starts with a comma (after skipping any leading whitespace), then
807  * splitting is done only on commas. No empty tokens are ever returned. */
808 char *conf_strtok(char *str)
809 {
810         static int commas_only = 0;
811
812         if (str) {
813                 while (isSpace(str)) str++;
814                 if (*str == ',') {
815                         commas_only = 1;
816                         str++;
817                 } else
818                         commas_only = 0;
819         }
820
821         while (commas_only) {
822                 char *end, *tok = strtok(str, ",");
823                 if (!tok)
824                         return NULL;
825                 /* Trim just leading and trailing whitespace. */
826                 while (isSpace(tok))
827                         tok++;
828                 end = tok + strlen(tok);
829                 while (end > tok && isSpace(end-1))
830                         *--end = '\0';
831                 if (*tok)
832                         return tok;
833                 str = NULL;
834         }
835
836         return strtok(str, " ,\t\r\n");
837 }
838
839 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them.  (If
840  * p1 ends with a '/', no extra '/' is inserted.)  Returns the length of both
841  * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
842  * string fits into destsize. */
843 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
844 {
845         size_t len = strlcpy(dest, p1, destsize);
846         if (len < destsize - 1) {
847                 if (!len || dest[len-1] != '/')
848                         dest[len++] = '/';
849                 if (len < destsize - 1)
850                         len += strlcpy(dest + len, p2, destsize - len);
851                 else {
852                         dest[len] = '\0';
853                         len += strlen(p2);
854                 }
855         }
856         else
857                 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
858         return len;
859 }
860
861 /* Join any number of strings together, putting them in "dest".  The return
862  * value is the length of all the strings, regardless of whether the null-
863  * terminated whole fits in destsize.  Your list of string pointers must end
864  * with a NULL to indicate the end of the list. */
865 size_t stringjoin(char *dest, size_t destsize, ...)
866 {
867         va_list ap;
868         size_t len, ret = 0;
869         const char *src;
870
871         va_start(ap, destsize);
872         while (1) {
873                 if (!(src = va_arg(ap, const char *)))
874                         break;
875                 len = strlen(src);
876                 ret += len;
877                 if (destsize > 1) {
878                         if (len >= destsize)
879                                 len = destsize - 1;
880                         memcpy(dest, src, len);
881                         destsize -= len;
882                         dest += len;
883                 }
884         }
885         *dest = '\0';
886         va_end(ap);
887
888         return ret;
889 }
890
891 int count_dir_elements(const char *p)
892 {
893         int cnt = 0, new_component = 1;
894         while (*p) {
895                 if (*p++ == '/')
896                         new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
897                 else if (new_component) {
898                         new_component = 0;
899                         cnt++;
900                 }
901         }
902         return cnt;
903 }
904
905 /* Turns multiple adjacent slashes into a single slash (possible exception:
906  * the preserving of two leading slashes at the start), drops all leading or
907  * interior "." elements unless CFN_KEEP_DOT_DIRS is flagged.  Will also drop
908  * a trailing '.' after a '/' if CFN_DROP_TRAILING_DOT_DIR is flagged, removes
909  * a trailing slash (perhaps after removing the aforementioned dot) unless
910  * CFN_KEEP_TRAILING_SLASH is flagged, and will also collapse ".." elements
911  * (except at the start) if CFN_COLLAPSE_DOT_DOT_DIRS is flagged.  If the
912  * resulting name would be empty, returns ".". */
913 int clean_fname(char *name, int flags)
914 {
915         char *limit = name - 1, *t = name, *f = name;
916         int anchored;
917
918         if (!name)
919                 return 0;
920
921 #define DOT_IS_DOT_DOT_DIR(bp) (bp[1] == '.' && (bp[2] == '/' || !bp[2]))
922
923         if ((anchored = *f == '/') != 0) {
924                 *t++ = *f++;
925 #ifdef __CYGWIN__
926                 /* If there are exactly 2 slashes at the start, preserve
927                  * them.  Would break daemon excludes unless the paths are
928                  * really treated differently, so used this sparingly. */
929                 if (*f == '/' && f[1] != '/')
930                         *t++ = *f++;
931 #endif
932         } else if (flags & CFN_KEEP_DOT_DIRS && *f == '.' && f[1] == '/') {
933                 *t++ = *f++;
934                 *t++ = *f++;
935         } else if (flags & CFN_REFUSE_DOT_DOT_DIRS && *f == '.' && DOT_IS_DOT_DOT_DIR(f))
936                 return -1;
937         while (*f) {
938                 /* discard extra slashes */
939                 if (*f == '/') {
940                         f++;
941                         continue;
942                 }
943                 if (*f == '.') {
944                         /* discard interior "." dirs */
945                         if (f[1] == '/' && !(flags & CFN_KEEP_DOT_DIRS)) {
946                                 f += 2;
947                                 continue;
948                         }
949                         if (f[1] == '\0' && flags & CFN_DROP_TRAILING_DOT_DIR)
950                                 break;
951                         /* collapse ".." dirs */
952                         if (flags & (CFN_COLLAPSE_DOT_DOT_DIRS|CFN_REFUSE_DOT_DOT_DIRS) && DOT_IS_DOT_DOT_DIR(f)) {
953                                 char *s = t - 1;
954                                 if (flags & CFN_REFUSE_DOT_DOT_DIRS)
955                                         return -1;
956                                 if (s == name && anchored) {
957                                         f += 2;
958                                         continue;
959                                 }
960                                 while (s > limit && *--s != '/') {}
961                                 if (s != t - 1 && (s < name || *s == '/')) {
962                                         t = s + 1;
963                                         f += 2;
964                                         continue;
965                                 }
966                                 limit = t + 2;
967                         }
968                 }
969                 while (*f && (*t++ = *f++) != '/') {}
970         }
971
972         if (t > name+anchored && t[-1] == '/' && !(flags & CFN_KEEP_TRAILING_SLASH))
973                 t--;
974         if (t == name)
975                 *t++ = '.';
976         *t = '\0';
977
978 #undef DOT_IS_DOT_DOT_DIR
979
980         return t - name;
981 }
982
983 /* Make path appear as if a chroot had occurred.  This handles a leading
984  * "/" (either removing it or expanding it) and any leading or embedded
985  * ".." components that attempt to escape past the module's top dir.
986  *
987  * If dest is NULL, a buffer is allocated to hold the result.  It is legal
988  * to call with the dest and the path (p) pointing to the same buffer, but
989  * rootdir will be ignored to avoid expansion of the string.
990  *
991  * The rootdir string contains a value to use in place of a leading slash.
992  * Specify NULL to get the default of "module_dir".
993  *
994  * The depth var is a count of how many '..'s to allow at the start of the
995  * path.
996  *
997  * We also clean the path in a manner similar to clean_fname() but with a
998  * few differences:
999  *
1000  * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
1001  * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
1002  * ALWAYS collapses ".." elements (except for those at the start of the
1003  * string up to "depth" deep).  If the resulting name would be empty,
1004  * change it into a ".". */
1005 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth,
1006                     int flags)
1007 {
1008         char *start, *sanp;
1009         int rlen = 0, drop_dot_dirs = !relative_paths || !(flags & SP_KEEP_DOT_DIRS);
1010
1011         if (dest != p) {
1012                 int plen = strlen(p); /* the path len INCLUDING any separating slash */
1013                 if (*p == '/') {
1014                         if (!rootdir)
1015                                 rootdir = module_dir;
1016                         rlen = strlen(rootdir);
1017                         depth = 0;
1018                         p++;
1019                 }
1020                 if (dest) {
1021                         if (rlen + plen + 1 >= MAXPATHLEN)
1022                                 return NULL;
1023                 } else if (!(dest = new_array(char, MAX(rlen + plen + 1, 2))))
1024                         out_of_memory("sanitize_path");
1025                 if (rlen) { /* only true if p previously started with a slash */
1026                         memcpy(dest, rootdir, rlen);
1027                         if (rlen > 1) /* a rootdir of len 1 is "/", so this avoids a 2nd slash */
1028                                 dest[rlen++] = '/';
1029                 }
1030         }
1031
1032         if (drop_dot_dirs) {
1033                 while (*p == '.' && p[1] == '/')
1034                         p += 2;
1035         }
1036
1037         start = sanp = dest + rlen;
1038         /* This loop iterates once per filename component in p, pointing at
1039          * the start of the name (past any prior slash) for each iteration. */
1040         while (*p) {
1041                 /* discard leading or extra slashes */
1042                 if (*p == '/') {
1043                         p++;
1044                         continue;
1045                 }
1046                 if (drop_dot_dirs) {
1047                         if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
1048                                 /* skip "." component */
1049                                 p++;
1050                                 continue;
1051                         }
1052                 }
1053                 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
1054                         /* ".." component followed by slash or end */
1055                         if (depth <= 0 || sanp != start) {
1056                                 p += 2;
1057                                 if (sanp != start) {
1058                                         /* back up sanp one level */
1059                                         --sanp; /* now pointing at slash */
1060                                         while (sanp > start && sanp[-1] != '/')
1061                                                 sanp--;
1062                                 }
1063                                 continue;
1064                         }
1065                         /* allow depth levels of .. at the beginning */
1066                         depth--;
1067                         /* move the virtual beginning to leave the .. alone */
1068                         start = sanp + 3;
1069                 }
1070                 /* copy one component through next slash */
1071                 while (*p && (*sanp++ = *p++) != '/') {}
1072         }
1073         if (sanp == dest) {
1074                 /* ended up with nothing, so put in "." component */
1075                 *sanp++ = '.';
1076         }
1077         *sanp = '\0';
1078
1079         return dest;
1080 }
1081
1082 /* Like chdir(), but it keeps track of the current directory (in the
1083  * global "curr_dir"), and ensures that the path size doesn't overflow.
1084  * Also cleans the path using the clean_fname() function. */
1085 int change_dir(const char *dir, int set_path_only)
1086 {
1087         static int initialised, skipped_chdir;
1088         unsigned int len;
1089
1090         if (!initialised) {
1091                 initialised = 1;
1092                 if (getcwd(curr_dir, sizeof curr_dir - 1) == NULL) {
1093                         rsyserr(FERROR, errno, "getcwd()");
1094                         exit_cleanup(RERR_FILESELECT);
1095                 }
1096                 curr_dir_len = strlen(curr_dir);
1097         }
1098
1099         if (!dir)       /* this call was probably just to initialize */
1100                 return 0;
1101
1102         len = strlen(dir);
1103         if (len == 1 && *dir == '.' && (!skipped_chdir || set_path_only))
1104                 return 1;
1105
1106         if (*dir == '/') {
1107                 if (len >= sizeof curr_dir) {
1108                         errno = ENAMETOOLONG;
1109                         return 0;
1110                 }
1111                 if (!set_path_only && chdir(dir))
1112                         return 0;
1113                 skipped_chdir = set_path_only;
1114                 memcpy(curr_dir, dir, len + 1);
1115         } else {
1116                 if (curr_dir_len + 1 + len >= sizeof curr_dir) {
1117                         errno = ENAMETOOLONG;
1118                         return 0;
1119                 }
1120                 if (!(curr_dir_len && curr_dir[curr_dir_len-1] == '/'))
1121                         curr_dir[curr_dir_len++] = '/';
1122                 memcpy(curr_dir + curr_dir_len, dir, len + 1);
1123
1124                 if (!set_path_only && chdir(curr_dir)) {
1125                         curr_dir[curr_dir_len] = '\0';
1126                         return 0;
1127                 }
1128                 skipped_chdir = set_path_only;
1129         }
1130
1131         curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1132         if (sanitize_paths) {
1133                 if (module_dirlen > curr_dir_len)
1134                         module_dirlen = curr_dir_len;
1135                 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
1136         }
1137
1138         if (DEBUG_GTE(CHDIR, 1) && !set_path_only)
1139                 rprintf(FINFO, "[%s] change_dir(%s)\n", who_am_i(), curr_dir);
1140
1141         return 1;
1142 }
1143
1144 /* This will make a relative path absolute and clean it up via clean_fname().
1145  * Returns the string, which might be newly allocated, or NULL on error. */
1146 char *normalize_path(char *path, BOOL force_newbuf, unsigned int *len_ptr)
1147 {
1148         unsigned int len;
1149
1150         if (*path != '/') { /* Make path absolute. */
1151                 int len = strlen(path);
1152                 if (curr_dir_len + 1 + len >= sizeof curr_dir)
1153                         return NULL;
1154                 curr_dir[curr_dir_len] = '/';
1155                 memcpy(curr_dir + curr_dir_len + 1, path, len + 1);
1156                 if (!(path = strdup(curr_dir)))
1157                         out_of_memory("normalize_path");
1158                 curr_dir[curr_dir_len] = '\0';
1159         } else if (force_newbuf) {
1160                 if (!(path = strdup(path)))
1161                         out_of_memory("normalize_path");
1162         }
1163
1164         len = clean_fname(path, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1165
1166         if (len_ptr)
1167                 *len_ptr = len;
1168
1169         return path;
1170 }
1171
1172 /**
1173  * Return a quoted string with the full pathname of the indicated filename.
1174  * The string " (in MODNAME)" may also be appended.  The returned pointer
1175  * remains valid until the next time full_fname() is called.
1176  **/
1177 char *full_fname(const char *fn)
1178 {
1179         static char *result = NULL;
1180         char *m1, *m2, *m3;
1181         char *p1, *p2;
1182
1183         if (result)
1184                 free(result);
1185
1186         if (*fn == '/')
1187                 p1 = p2 = "";
1188         else {
1189                 p1 = curr_dir + module_dirlen;
1190                 for (p2 = p1; *p2 == '/'; p2++) {}
1191                 if (*p2)
1192                         p2 = "/";
1193         }
1194         if (module_id >= 0) {
1195                 m1 = " (in ";
1196                 m2 = lp_name(module_id);
1197                 m3 = ")";
1198         } else
1199                 m1 = m2 = m3 = "";
1200
1201         if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) < 0)
1202                 out_of_memory("full_fname");
1203
1204         return result;
1205 }
1206
1207 static char partial_fname[MAXPATHLEN];
1208
1209 char *partial_dir_fname(const char *fname)
1210 {
1211         char *t = partial_fname;
1212         int sz = sizeof partial_fname;
1213         const char *fn;
1214
1215         if ((fn = strrchr(fname, '/')) != NULL) {
1216                 fn++;
1217                 if (*partial_dir != '/') {
1218                         int len = fn - fname;
1219                         strncpy(t, fname, len); /* safe */
1220                         t += len;
1221                         sz -= len;
1222                 }
1223         } else
1224                 fn = fname;
1225         if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
1226                 return NULL;
1227         if (daemon_filter_list.head) {
1228                 t = strrchr(partial_fname, '/');
1229                 *t = '\0';
1230                 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 1) < 0)
1231                         return NULL;
1232                 *t = '/';
1233                 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 0) < 0)
1234                         return NULL;
1235         }
1236
1237         return partial_fname;
1238 }
1239
1240 /* If no --partial-dir option was specified, we don't need to do anything
1241  * (the partial-dir is essentially '.'), so just return success. */
1242 int handle_partial_dir(const char *fname, int create)
1243 {
1244         char *fn, *dir;
1245
1246         if (fname != partial_fname)
1247                 return 1;
1248         if (!create && *partial_dir == '/')
1249                 return 1;
1250         if (!(fn = strrchr(partial_fname, '/')))
1251                 return 1;
1252
1253         *fn = '\0';
1254         dir = partial_fname;
1255         if (create) {
1256                 STRUCT_STAT st;
1257                 int statret = do_lstat(dir, &st);
1258                 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1259                         if (do_unlink(dir) < 0) {
1260                                 *fn = '/';
1261                                 return 0;
1262                         }
1263                         statret = -1;
1264                 }
1265                 if (statret < 0 && do_mkdir(dir, 0700) < 0) {
1266                         *fn = '/';
1267                         return 0;
1268                 }
1269         } else
1270                 do_rmdir(dir);
1271         *fn = '/';
1272
1273         return 1;
1274 }
1275
1276 /* Determine if a symlink points outside the current directory tree.
1277  * This is considered "unsafe" because e.g. when mirroring somebody
1278  * else's machine it might allow them to establish a symlink to
1279  * /etc/passwd, and then read it through a web server.
1280  *
1281  * Returns 1 if unsafe, 0 if safe.
1282  *
1283  * Null symlinks and absolute symlinks are always unsafe.
1284  *
1285  * Basically here we are concerned with symlinks whose target contains
1286  * "..", because this might cause us to walk back up out of the
1287  * transferred directory.  We are not allowed to go back up and
1288  * reenter.
1289  *
1290  * "dest" is the target of the symlink in question.
1291  *
1292  * "src" is the top source directory currently applicable at the level
1293  * of the referenced symlink.  This is usually the symlink's full path
1294  * (including its name), as referenced from the root of the transfer. */
1295 int unsafe_symlink(const char *dest, const char *src)
1296 {
1297         const char *name, *slash;
1298         int depth = 0;
1299
1300         /* all absolute and null symlinks are unsafe */
1301         if (!dest || !*dest || *dest == '/')
1302                 return 1;
1303
1304         /* find out what our safety margin is */
1305         for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1306                 /* ".." segment starts the count over.  "." segment is ignored. */
1307                 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1308                         if (name[1] == '.')
1309                                 depth = 0;
1310                 } else
1311                         depth++;
1312                 while (slash[1] == '/') slash++; /* just in case src isn't clean */
1313         }
1314         if (*name == '.' && name[1] == '.' && name[2] == '\0')
1315                 depth = 0;
1316
1317         for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1318                 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1319                         if (name[1] == '.') {
1320                                 /* if at any point we go outside the current directory
1321                                    then stop - it is unsafe */
1322                                 if (--depth < 0)
1323                                         return 1;
1324                         }
1325                 } else
1326                         depth++;
1327                 while (slash[1] == '/') slash++;
1328         }
1329         if (*name == '.' && name[1] == '.' && name[2] == '\0')
1330                 depth--;
1331
1332         return depth < 0;
1333 }
1334
1335 /* Return the date and time as a string.  Some callers tweak returned buf. */
1336 char *timestring(time_t t)
1337 {
1338         static char TimeBuf[200];
1339         struct tm *tm = localtime(&t);
1340         char *p;
1341
1342 #ifdef HAVE_STRFTIME
1343         strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1344 #else
1345         strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1346 #endif
1347
1348         if ((p = strchr(TimeBuf, '\n')) != NULL)
1349                 *p = '\0';
1350
1351         return TimeBuf;
1352 }
1353
1354 /* Determine if two time_t values are equivalent (either exact, or in
1355  * the modification timestamp window established by --modify-window).
1356  *
1357  * @retval 0 if the times should be treated as the same
1358  *
1359  * @retval +1 if the first is later
1360  *
1361  * @retval -1 if the 2nd is later
1362  **/
1363 int cmp_time(time_t f1_sec, unsigned long f1_nsec, time_t f2_sec, unsigned long f2_nsec)
1364 {
1365         if (f2_sec > f1_sec) {
1366                 /* The final comparison makes sure that modify_window doesn't overflow a
1367                  * time_t, which would mean that f2_sec must be in the equality window. */
1368                 if (modify_window <= 0 || (f2_sec > f1_sec + modify_window && f1_sec + modify_window > f1_sec))
1369                         return -1;
1370         } else if (f1_sec > f2_sec) {
1371                 if (modify_window <= 0 || (f1_sec > f2_sec + modify_window && f2_sec + modify_window > f2_sec))
1372                         return 1;
1373         } else if (modify_window < 0) {
1374                 if (f2_nsec > f1_nsec)
1375                         return -1;
1376                 else if (f1_nsec > f2_nsec)
1377                         return 1;
1378         }
1379         return 0;
1380 }
1381
1382 #ifdef __INSURE__XX
1383 #include <dlfcn.h>
1384
1385 /**
1386    This routine is a trick to immediately catch errors when debugging
1387    with insure. A xterm with a gdb is popped up when insure catches
1388    a error. It is Linux specific.
1389 **/
1390 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1391 {
1392         static int (*fn)();
1393         int ret, pid_int = getpid();
1394         char *cmd;
1395
1396         if (asprintf(&cmd,
1397             "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; "
1398             "gdb /proc/%d/exe %d'", pid_int, pid_int, pid_int) < 0)
1399                 return -1;
1400
1401         if (!fn) {
1402                 static void *h;
1403                 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1404                 fn = dlsym(h, "_Insure_trap_error");
1405         }
1406
1407         ret = fn(a1, a2, a3, a4, a5, a6);
1408
1409         system(cmd);
1410
1411         free(cmd);
1412
1413         return ret;
1414 }
1415 #endif
1416
1417 /* Take a filename and filename length and return the most significant
1418  * filename suffix we can find.  This ignores suffixes such as "~",
1419  * ".bak", ".orig", ".~1~", etc. */
1420 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1421 {
1422         const char *suf, *s;
1423         BOOL had_tilde;
1424         int s_len;
1425
1426         /* One or more dots at the start aren't a suffix. */
1427         while (fn_len && *fn == '.') fn++, fn_len--;
1428
1429         /* Ignore the ~ in a "foo~" filename. */
1430         if (fn_len > 1 && fn[fn_len-1] == '~')
1431                 fn_len--, had_tilde = True;
1432         else
1433                 had_tilde = False;
1434
1435         /* Assume we don't find an suffix. */
1436         suf = "";
1437         *len_ptr = 0;
1438
1439         /* Find the last significant suffix. */
1440         for (s = fn + fn_len; fn_len > 1; ) {
1441                 while (*--s != '.' && s != fn) {}
1442                 if (s == fn)
1443                         break;
1444                 s_len = fn_len - (s - fn);
1445                 fn_len = s - fn;
1446                 if (s_len == 4) {
1447                         if (strcmp(s+1, "bak") == 0
1448                          || strcmp(s+1, "old") == 0)
1449                                 continue;
1450                 } else if (s_len == 5) {
1451                         if (strcmp(s+1, "orig") == 0)
1452                                 continue;
1453                 } else if (s_len > 2 && had_tilde
1454                     && s[1] == '~' && isDigit(s + 2))
1455                         continue;
1456                 *len_ptr = s_len;
1457                 suf = s;
1458                 if (s_len == 1)
1459                         break;
1460                 /* Determine if the suffix is all digits. */
1461                 for (s++, s_len--; s_len > 0; s++, s_len--) {
1462                         if (!isDigit(s))
1463                                 return suf;
1464                 }
1465                 /* An all-digit suffix may not be that signficant. */
1466                 s = suf;
1467         }
1468
1469         return suf;
1470 }
1471
1472 /* This is an implementation of the Levenshtein distance algorithm.  It
1473  * was implemented to avoid needing a two-dimensional matrix (to save
1474  * memory).  It was also tweaked to try to factor in the ASCII distance
1475  * between changed characters as a minor distance quantity.  The normal
1476  * Levenshtein units of distance (each signifying a single change between
1477  * the two strings) are defined as a "UNIT". */
1478
1479 #define UNIT (1 << 16)
1480
1481 uint32 fuzzy_distance(const char *s1, unsigned len1, const char *s2, unsigned len2)
1482 {
1483         uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1484         int32 cost;
1485         unsigned i1, i2;
1486
1487         if (!len1 || !len2) {
1488                 if (!len1) {
1489                         s1 = s2;
1490                         len1 = len2;
1491                 }
1492                 for (i1 = 0, cost = 0; i1 < len1; i1++)
1493                         cost += s1[i1];
1494                 return (int32)len1 * UNIT + cost;
1495         }
1496
1497         for (i2 = 0; i2 < len2; i2++)
1498                 a[i2] = (i2+1) * UNIT;
1499
1500         for (i1 = 0; i1 < len1; i1++) {
1501                 diag = i1 * UNIT;
1502                 above = (i1+1) * UNIT;
1503                 for (i2 = 0; i2 < len2; i2++) {
1504                         left = a[i2];
1505                         if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1506                                 if (cost < 0)
1507                                         cost = UNIT - cost;
1508                                 else
1509                                         cost = UNIT + cost;
1510                         }
1511                         diag_inc = diag + cost;
1512                         left_inc = left + UNIT + *((uchar*)s1+i1);
1513                         above_inc = above + UNIT + *((uchar*)s2+i2);
1514                         a[i2] = above = left < above
1515                               ? (left_inc < diag_inc ? left_inc : diag_inc)
1516                               : (above_inc < diag_inc ? above_inc : diag_inc);
1517                         diag = left;
1518                 }
1519         }
1520
1521         return a[len2-1];
1522 }
1523
1524 #define BB_SLOT_SIZE     (16*1024)          /* Desired size in bytes */
1525 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1526 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1527
1528 struct bitbag {
1529     uint32 **bits;
1530     int slot_cnt;
1531 };
1532
1533 struct bitbag *bitbag_create(int max_ndx)
1534 {
1535         struct bitbag *bb = new(struct bitbag);
1536         bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1537
1538         if (!(bb->bits = (uint32**)calloc(bb->slot_cnt, sizeof (uint32*))))
1539                 out_of_memory("bitbag_create");
1540
1541         return bb;
1542 }
1543
1544 void bitbag_set_bit(struct bitbag *bb, int ndx)
1545 {
1546         int slot = ndx / BB_PER_SLOT_BITS;
1547         ndx %= BB_PER_SLOT_BITS;
1548
1549         if (!bb->bits[slot]) {
1550                 if (!(bb->bits[slot] = (uint32*)calloc(BB_PER_SLOT_INTS, 4)))
1551                         out_of_memory("bitbag_set_bit");
1552         }
1553
1554         bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1555 }
1556
1557 #if 0 /* not needed yet */
1558 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1559 {
1560         int slot = ndx / BB_PER_SLOT_BITS;
1561         ndx %= BB_PER_SLOT_BITS;
1562
1563         if (!bb->bits[slot])
1564                 return;
1565
1566         bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1567 }
1568
1569 int bitbag_check_bit(struct bitbag *bb, int ndx)
1570 {
1571         int slot = ndx / BB_PER_SLOT_BITS;
1572         ndx %= BB_PER_SLOT_BITS;
1573
1574         if (!bb->bits[slot])
1575                 return 0;
1576
1577         return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1578 }
1579 #endif
1580
1581 /* Call this with -1 to start checking from 0.  Returns -1 at the end. */
1582 int bitbag_next_bit(struct bitbag *bb, int after)
1583 {
1584         uint32 bits, mask;
1585         int i, ndx = after + 1;
1586         int slot = ndx / BB_PER_SLOT_BITS;
1587         ndx %= BB_PER_SLOT_BITS;
1588
1589         mask = (1u << (ndx % 32)) - 1;
1590         for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1591                 if (!bb->bits[slot])
1592                         continue;
1593                 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1594                         if (!(bits = bb->bits[slot][i] & ~mask))
1595                                 continue;
1596                         /* The xor magic figures out the lowest enabled bit in
1597                          * bits, and the switch quickly computes log2(bit). */
1598                         switch (bits ^ (bits & (bits-1))) {
1599 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1600                             LOG2(0);  LOG2(1);  LOG2(2);  LOG2(3);
1601                             LOG2(4);  LOG2(5);  LOG2(6);  LOG2(7);
1602                             LOG2(8);  LOG2(9);  LOG2(10); LOG2(11);
1603                             LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1604                             LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1605                             LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1606                             LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1607                             LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1608                         }
1609                         return -1; /* impossible... */
1610                 }
1611         }
1612
1613         return -1;
1614 }
1615
1616 void flist_ndx_push(flist_ndx_list *lp, int ndx)
1617 {
1618         struct flist_ndx_item *item;
1619
1620         if (!(item = new(struct flist_ndx_item)))
1621                 out_of_memory("flist_ndx_push");
1622         item->next = NULL;
1623         item->ndx = ndx;
1624         if (lp->tail)
1625                 lp->tail->next = item;
1626         else
1627                 lp->head = item;
1628         lp->tail = item;
1629 }
1630
1631 int flist_ndx_pop(flist_ndx_list *lp)
1632 {
1633         struct flist_ndx_item *next;
1634         int ndx;
1635
1636         if (!lp->head)
1637                 return -1;
1638
1639         ndx = lp->head->ndx;
1640         next = lp->head->next;
1641         free(lp->head);
1642         lp->head = next;
1643         if (!next)
1644                 lp->tail = NULL;
1645
1646         return ndx;
1647 }
1648
1649 /* Make sure there is room for one more item in the item list.  If there
1650  * is not, expand the list as indicated by the value of "incr":
1651  *  - if incr < 0 then increase the malloced size by -1 * incr
1652  *  - if incr >= 0 then either make the malloced size equal to "incr"
1653  *    or (if that's not large enough) double the malloced size
1654  * After the size check, the list's count is incremented by 1 and a pointer
1655  * to the "new" list item is returned.
1656  */
1657 void *expand_item_list(item_list *lp, size_t item_size,
1658                        const char *desc, int incr)
1659 {
1660         /* First time through, 0 <= 0, so list is expanded. */
1661         if (lp->malloced <= lp->count) {
1662                 void *new_ptr;
1663                 size_t new_size = lp->malloced;
1664                 if (incr < 0)
1665                         new_size += -incr; /* increase slowly */
1666                 else if (new_size < (size_t)incr)
1667                         new_size = incr;
1668                 else if (new_size)
1669                         new_size *= 2;
1670                 else
1671                         new_size = 1;
1672                 if (new_size <= lp->malloced)
1673                         overflow_exit("expand_item_list");
1674                 /* Using _realloc_array() lets us pass the size, not a type. */
1675                 new_ptr = _realloc_array(lp->items, item_size, new_size);
1676                 if (DEBUG_GTE(FLIST, 3)) {
1677                         rprintf(FINFO, "[%s] expand %s to %s bytes, did%s move\n",
1678                                 who_am_i(), desc, big_num(new_size * item_size),
1679                                 new_ptr == lp->items ? " not" : "");
1680                 }
1681                 if (!new_ptr)
1682                         out_of_memory("expand_item_list");
1683
1684                 lp->items = new_ptr;
1685                 lp->malloced = new_size;
1686         }
1687         return (char*)lp->items + (lp->count++ * item_size);
1688 }