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