2 * Utility routines used in rsync.
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-2018 Wayne Davison
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.
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.
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.
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;
41 int sanitize_paths = 0;
43 char curr_dir[MAXPATHLEN];
44 unsigned int curr_dir_len;
45 int curr_dir_depth; /* This is only set for a sanitizing daemon. */
47 /* Set a fd into nonblocking mode. */
48 void set_nonblocking(int fd)
52 if ((val = fcntl(fd, F_GETFL)) == -1)
54 if (!(val & NONBLOCK_FLAG)) {
56 fcntl(fd, F_SETFL, val);
60 /* Set a fd into blocking mode. */
61 void set_blocking(int fd)
65 if ((val = fcntl(fd, F_GETFL)) == -1)
67 if (val & NONBLOCK_FLAG) {
68 val &= ~NONBLOCK_FLAG;
69 fcntl(fd, F_SETFL, val);
74 * Create a file descriptor pair - like pipe() but use socketpair if
75 * possible (because of blocking issues on pipes).
77 * Always set non-blocking.
79 int fd_pair(int fd[2])
83 #ifdef HAVE_SOCKETPAIR
84 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
90 set_nonblocking(fd[0]);
91 set_nonblocking(fd[1]);
97 void print_child_argv(const char *prefix, char **cmd)
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"
108 ",.-_=+@/") != strlen(*cmd)) {
109 rprintf(FCLIENT, "\"%s\" ", *cmd);
111 rprintf(FCLIENT, "%s ", *cmd);
115 rprintf(FCLIENT, " (%d args)\n", cnt);
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)
122 static int switch_step = 0;
124 if (DEBUG_GTE(TIME, 1)) {
125 rprintf(FINFO, "set modtime of %s to (%ld) %s",
126 fname, (long)modtime,
127 asctime(localtime(&modtime)));
130 switch (switch_step) {
131 #ifdef HAVE_SETATTRLIST
133 if (do_setattrlist_times(fname, modtime, mod_nsec) == 0)
140 #ifdef HAVE_UTIMENSAT
142 if (do_utimensat(fname, modtime, mod_nsec) == 0)
151 if (do_lutimes(fname, modtime, mod_nsec) == 0)
160 if (preserve_times & PRESERVE_LINK_TIMES) {
161 preserve_times &= ~PRESERVE_LINK_TIMES;
168 if (do_utimes(fname, modtime, mod_nsec) == 0)
171 if (do_utime(fname, modtime, mod_nsec) == 0)
181 /* Create any necessary directories in fname. Any missing directories are
182 * created with default permissions. Returns < 0 on error, or the number
183 * of directories created. */
184 int make_path(char *fname, int flags)
189 if (flags & MKP_SKIP_SLASH) {
190 while (*fname == '/')
194 while (*fname == '.' && fname[1] == '/')
197 if (flags & MKP_DROP_NAME) {
198 end = strrchr(fname, '/');
199 if (!end || end == fname)
203 end = fname + strlen(fname);
205 /* Try to find an existing dir, starting from the deepest dir. */
209 if (do_stat(fname, &st) == 0) {
210 if (S_ISDIR(st.st_mode))
215 } else if (do_mkdir(fname, ACCESSPERMS) == 0) {
220 if (errno != ENOENT) {
222 if (errno != EEXIST || (do_stat(fname, &st) == 0 && !S_ISDIR(st.st_mode)))
228 /* We got a relative path that doesn't exist, so assume that '.'
229 * is there and just break out and create the whole thing. */
235 /* We reached the "/" dir, which we assume is there. */
245 /* Make all the dirs that we didn't find on the way here. */
252 if (ret < 0) /* Skip mkdir on error, but keep restoring the path. */
254 if (do_mkdir(fname, ACCESSPERMS) < 0)
260 if (flags & MKP_DROP_NAME)
267 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
270 * @retval len upon success
272 * @retval <0 write's (negative) error code
274 * Derived from GNU C's cccp.c.
276 int full_write(int desc, const char *ptr, size_t len)
282 int written = write(desc, ptr, len);
288 total_written += written;
292 return total_written;
296 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
299 * @retval >0 the actual number of bytes read
303 * @retval <0 for an error.
305 * Derived from GNU C's cccp.c. */
306 static int safe_read(int desc, char *ptr, size_t len)
314 n_chars = read(desc, ptr, len);
315 } while (n_chars < 0 && errno == EINTR);
320 /* Copy a file. If ofd < 0, copy_file unlinks and opens the "dest" file.
321 * Otherwise, it just writes to and closes the provided file descriptor.
322 * In either case, if --xattrs are being preserved, the dest file will
323 * have its xattrs set from the source file.
325 * This is used in conjunction with the --temp-dir, --backup, and
326 * --copy-dest options. */
327 int copy_file(const char *source, const char *dest, int ofd, mode_t mode)
331 int len; /* Number of bytes read into `buf'. */
332 OFF_T prealloc_len = 0, offset = 0;
334 if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
335 int save_errno = errno;
336 rsyserr(FERROR_XFER, errno, "open %s", full_fname(source));
342 if (robust_unlink(dest) && errno != ENOENT) {
343 int save_errno = errno;
344 rsyserr(FERROR_XFER, errno, "unlink %s", full_fname(dest));
350 #ifdef SUPPORT_XATTRS
354 mode &= INITACCESSPERMS;
355 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0) {
356 int save_errno = errno;
357 rsyserr(FERROR_XFER, save_errno, "open %s", full_fname(dest));
364 #ifdef SUPPORT_PREALLOCATION
365 if (preallocate_files) {
368 /* Try to preallocate enough space for file's eventual length. Can
369 * reduce fragmentation on filesystems like ext4, xfs, and NTFS. */
370 if (do_fstat(ifd, &srcst) < 0)
371 rsyserr(FWARNING, errno, "fstat %s", full_fname(source));
372 else if (srcst.st_size > 0) {
373 prealloc_len = do_fallocate(ofd, 0, srcst.st_size);
374 if (prealloc_len < 0)
375 rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(dest));
380 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
381 if (full_write(ofd, buf, len) < 0) {
382 int save_errno = errno;
383 rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
393 int save_errno = errno;
394 rsyserr(FERROR_XFER, errno, "read %s", full_fname(source));
401 if (close(ifd) < 0) {
402 rsyserr(FWARNING, errno, "close failed on %s",
406 /* Source file might have shrunk since we fstatted it.
407 * Cut off any extra preallocated zeros from dest file. */
408 if (offset < prealloc_len && do_ftruncate(ofd, offset) < 0) {
409 /* If we fail to truncate, the dest file may be wrong, so we
410 * must trigger the "partial transfer" error. */
411 rsyserr(FERROR_XFER, errno, "ftruncate %s", full_fname(dest));
414 if (close(ofd) < 0) {
415 int save_errno = errno;
416 rsyserr(FERROR_XFER, errno, "close failed on %s",
422 #ifdef SUPPORT_XATTRS
424 copy_xattrs(source, dest);
430 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
431 #define MAX_RENAMES_DIGITS 3
432 #define MAX_RENAMES 1000
435 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
436 * rename to <path>/.rsyncNNN instead.
438 * Note that successive rsync runs will shuffle the filenames around a
439 * bit as long as the file is still busy; this is because this function
440 * does not know if the unlink call is due to a new file coming in, or
441 * --delete trying to remove old .rsyncNNN files, hence it renames it
444 int robust_unlink(const char *fname)
447 return do_unlink(fname);
449 static int counter = 1;
451 char path[MAXPATHLEN];
453 rc = do_unlink(fname);
454 if (rc == 0 || errno != ETXTBSY)
457 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
458 pos = MAXPATHLEN - 1;
460 while (pos > 0 && path[pos-1] != '/')
462 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
464 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
469 /* start where the last one left off to reduce chance of clashes */
472 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
473 if (++counter >= MAX_RENAMES)
475 } while ((rc = access(path, 0)) == 0 && counter != start);
477 if (INFO_GTE(MISC, 1)) {
478 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
482 /* maybe we should return rename()'s exit status? Nah. */
483 if (do_rename(fname, path) != 0) {
491 /* Returns 0 on successful rename, 1 if we successfully copied the file
492 * across filesystems, -2 if copy_file() failed, and -1 on other errors.
493 * If partialptr is not NULL and we need to do a copy, copy the file into
494 * the active partial-dir instead of over the destination file. */
495 int robust_rename(const char *from, const char *to, const char *partialptr,
501 if (do_rename(from, to) == 0)
507 if (robust_unlink(to) != 0) {
516 if (!handle_partial_dir(partialptr,PDIR_CREATE))
520 if (copy_file(from, to, -1, mode) != 0)
531 static pid_t all_pids[10];
534 /** Fork and record the pid of the child. **/
537 pid_t newpid = fork();
539 if (newpid != 0 && newpid != -1) {
540 all_pids[num_pids++] = newpid;
548 * @todo It would be kind of nice to make sure that they are actually
549 * all our children before we kill them, because their pids may have
550 * been recycled by some other process. Perhaps when we wait for a
551 * child, we should remove it from this array. Alternatively we could
552 * perhaps use process groups, but I think that would not work on
553 * ancient Unix versions that don't support them.
555 void kill_all(int sig)
559 for (i = 0; i < num_pids; i++) {
560 /* Let's just be a little careful where we
561 * point that gun, hey? See kill(2) for the
562 * magic caused by negative values. */
563 pid_t p = all_pids[i];
574 /** Lock a byte range in a open file */
575 int lock_range(int fd, int offset, int len)
579 lock.l_type = F_WRLCK;
580 lock.l_whence = SEEK_SET;
581 lock.l_start = offset;
585 return fcntl(fd,F_SETLK,&lock) == 0;
588 #define ENSURE_MEMSPACE(buf, type, sz, req) \
589 if ((req) > sz && !(buf = realloc_array(buf, type, sz = MAX(sz * 2, req)))) \
590 out_of_memory("glob_expand")
592 static inline void call_glob_match(const char *name, int len, int from_glob,
593 char *arg, int abpos, int fbpos);
595 static struct glob_data {
596 char *arg_buf, *filt_buf, **argv;
597 int absize, fbsize, maxargs, argc;
600 static void glob_match(char *arg, int abpos, int fbpos)
605 while (*arg == '.' && arg[1] == '/') {
607 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, glob.absize);
608 memcpy(glob.filt_buf, glob.arg_buf, abpos + 1);
611 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + 3);
612 glob.arg_buf[abpos++] = *arg++;
613 glob.arg_buf[abpos++] = *arg++;
614 glob.arg_buf[abpos] = '\0';
616 if ((slash = strchr(arg, '/')) != NULL) {
621 if (strpbrk(arg, "*?[")) {
625 if (!(d = opendir(abpos ? glob.arg_buf : ".")))
627 while ((di = readdir(d)) != NULL) {
628 char *dname = d_name(di);
629 if (dname[0] == '.' && (dname[1] == '\0'
630 || (dname[1] == '.' && dname[2] == '\0')))
632 if (!wildmatch(arg, dname))
634 call_glob_match(dname, strlen(dname), 1,
635 slash ? arg + len + 1 : NULL,
640 call_glob_match(arg, len, 0,
641 slash ? arg + len + 1 : NULL,
648 static inline void call_glob_match(const char *name, int len, int from_glob,
649 char *arg, int abpos, int fbpos)
653 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + len + 2);
654 memcpy(glob.arg_buf + abpos, name, len);
656 glob.arg_buf[abpos] = '\0';
659 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, fbpos + len + 2);
660 memcpy(glob.filt_buf + fbpos, name, len);
662 glob.filt_buf[fbpos] = '\0';
663 use_buf = glob.filt_buf;
665 use_buf = glob.arg_buf;
667 if (from_glob || (arg && len)) {
671 if (do_stat(glob.arg_buf, &st) != 0)
673 is_dir = S_ISDIR(st.st_mode) != 0;
677 if (daemon_filter_list.head
678 && check_filter(&daemon_filter_list, FLOG, use_buf, is_dir) < 0)
683 glob.arg_buf[abpos++] = '/';
684 glob.arg_buf[abpos] = '\0';
686 glob.filt_buf[fbpos++] = '/';
687 glob.filt_buf[fbpos] = '\0';
689 glob_match(arg, abpos, fbpos);
691 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
692 if (!(glob.argv[glob.argc++] = strdup(glob.arg_buf)))
693 out_of_memory("glob_match");
697 /* This routine performs wild-card expansion of the pathname in "arg". Any
698 * daemon-excluded files/dirs will not be matched by the wildcards. Returns 0
699 * if a wild-card string is the only returned item (due to matching nothing). */
700 int glob_expand(const char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
709 memset(&glob, 0, sizeof glob);
714 s = sanitize_path(NULL, arg, "", 0, SP_KEEP_DOT_DIRS);
718 out_of_memory("glob_expand");
719 clean_fname(s, CFN_KEEP_DOT_DIRS
720 | CFN_KEEP_TRAILING_SLASH
721 | CFN_COLLAPSE_DOT_DOT_DIRS);
724 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, MAXPATHLEN);
725 *glob.arg_buf = '\0';
727 glob.argc = save_argc = *argc_p;
729 glob.maxargs = *maxargs_p;
731 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, 100);
733 glob_match(s, 0, -1);
735 /* The arg didn't match anything, so add the failed arg to the list. */
736 if (glob.argc == save_argc) {
737 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
738 glob.argv[glob.argc++] = s;
745 *maxargs_p = glob.maxargs;
752 /* This routine is only used in daemon mode. */
753 void glob_expand_module(char *base1, char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
757 int base_len = strlen(base);
762 if (strncmp(arg, base, base_len) == 0)
766 glob_expand(arg, argv_p, argc_p, maxargs_p);
770 if (!(arg = strdup(arg)))
771 out_of_memory("glob_expand_module");
773 if (asprintf(&base," %s/", base1) < 0)
774 out_of_memory("glob_expand_module");
777 for (s = arg; *s; s = p + base_len) {
778 if ((p = strstr(s, base)) != NULL)
779 *p = '\0'; /* split it at this point */
780 glob_expand(s, argv_p, argc_p, maxargs_p);
790 * Convert a string to lower case
792 void strlower(char *s)
802 * Split a string into tokens based (usually) on whitespace & commas. If the
803 * string starts with a comma (after skipping any leading whitespace), then
804 * splitting is done only on commas. No empty tokens are ever returned. */
805 char *conf_strtok(char *str)
807 static int commas_only = 0;
810 while (isSpace(str)) str++;
818 while (commas_only) {
819 char *end, *tok = strtok(str, ",");
822 /* Trim just leading and trailing whitespace. */
825 end = tok + strlen(tok);
826 while (end > tok && isSpace(end-1))
833 return strtok(str, " ,\t\r\n");
836 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
837 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
838 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
839 * string fits into destsize. */
840 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
842 size_t len = strlcpy(dest, p1, destsize);
843 if (len < destsize - 1) {
844 if (!len || dest[len-1] != '/')
846 if (len < destsize - 1)
847 len += strlcpy(dest + len, p2, destsize - len);
854 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
858 /* Join any number of strings together, putting them in "dest". The return
859 * value is the length of all the strings, regardless of whether the null-
860 * terminated whole fits in destsize. Your list of string pointers must end
861 * with a NULL to indicate the end of the list. */
862 size_t stringjoin(char *dest, size_t destsize, ...)
868 va_start(ap, destsize);
870 if (!(src = va_arg(ap, const char *)))
877 memcpy(dest, src, len);
888 int count_dir_elements(const char *p)
890 int cnt = 0, new_component = 1;
893 new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
894 else if (new_component) {
902 /* Turns multiple adjacent slashes into a single slash (possible exception:
903 * the preserving of two leading slashes at the start), drops all leading or
904 * interior "." elements unless CFN_KEEP_DOT_DIRS is flagged. Will also drop
905 * a trailing '.' after a '/' if CFN_DROP_TRAILING_DOT_DIR is flagged, removes
906 * a trailing slash (perhaps after removing the aforementioned dot) unless
907 * CFN_KEEP_TRAILING_SLASH is flagged, and will also collapse ".." elements
908 * (except at the start) if CFN_COLLAPSE_DOT_DOT_DIRS is flagged. If the
909 * resulting name would be empty, returns ".". */
910 int clean_fname(char *name, int flags)
912 char *limit = name - 1, *t = name, *f = name;
918 #define DOT_IS_DOT_DOT_DIR(bp) (bp[1] == '.' && (bp[2] == '/' || !bp[2]))
920 if ((anchored = *f == '/') != 0) {
923 /* If there are exactly 2 slashes at the start, preserve
924 * them. Would break daemon excludes unless the paths are
925 * really treated differently, so used this sparingly. */
926 if (*f == '/' && f[1] != '/')
929 } else if (flags & CFN_KEEP_DOT_DIRS && *f == '.' && f[1] == '/') {
932 } else if (flags & CFN_REFUSE_DOT_DOT_DIRS && *f == '.' && DOT_IS_DOT_DOT_DIR(f))
935 /* discard extra slashes */
941 /* discard interior "." dirs */
942 if (f[1] == '/' && !(flags & CFN_KEEP_DOT_DIRS)) {
946 if (f[1] == '\0' && flags & CFN_DROP_TRAILING_DOT_DIR)
948 /* collapse ".." dirs */
949 if (flags & (CFN_COLLAPSE_DOT_DOT_DIRS|CFN_REFUSE_DOT_DOT_DIRS) && DOT_IS_DOT_DOT_DIR(f)) {
951 if (flags & CFN_REFUSE_DOT_DOT_DIRS)
953 if (s == name && anchored) {
957 while (s > limit && *--s != '/') {}
958 if (s != t - 1 && (s < name || *s == '/')) {
966 while (*f && (*t++ = *f++) != '/') {}
969 if (t > name+anchored && t[-1] == '/' && !(flags & CFN_KEEP_TRAILING_SLASH))
975 #undef DOT_IS_DOT_DOT_DIR
980 /* Make path appear as if a chroot had occurred. This handles a leading
981 * "/" (either removing it or expanding it) and any leading or embedded
982 * ".." components that attempt to escape past the module's top dir.
984 * If dest is NULL, a buffer is allocated to hold the result. It is legal
985 * to call with the dest and the path (p) pointing to the same buffer, but
986 * rootdir will be ignored to avoid expansion of the string.
988 * The rootdir string contains a value to use in place of a leading slash.
989 * Specify NULL to get the default of "module_dir".
991 * The depth var is a count of how many '..'s to allow at the start of the
994 * We also clean the path in a manner similar to clean_fname() but with a
997 * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
998 * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
999 * ALWAYS collapses ".." elements (except for those at the start of the
1000 * string up to "depth" deep). If the resulting name would be empty,
1001 * change it into a ".". */
1002 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth,
1006 int rlen = 0, drop_dot_dirs = !relative_paths || !(flags & SP_KEEP_DOT_DIRS);
1009 int plen = strlen(p); /* the path len INCLUDING any separating slash */
1012 rootdir = module_dir;
1013 rlen = strlen(rootdir);
1018 if (rlen + plen + 1 >= MAXPATHLEN)
1020 } else if (!(dest = new_array(char, MAX(rlen + plen + 1, 2))))
1021 out_of_memory("sanitize_path");
1022 if (rlen) { /* only true if p previously started with a slash */
1023 memcpy(dest, rootdir, rlen);
1024 if (rlen > 1) /* a rootdir of len 1 is "/", so this avoids a 2nd slash */
1029 if (drop_dot_dirs) {
1030 while (*p == '.' && p[1] == '/')
1034 start = sanp = dest + rlen;
1035 /* This loop iterates once per filename component in p, pointing at
1036 * the start of the name (past any prior slash) for each iteration. */
1038 /* discard leading or extra slashes */
1043 if (drop_dot_dirs) {
1044 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
1045 /* skip "." component */
1050 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
1051 /* ".." component followed by slash or end */
1052 if (depth <= 0 || sanp != start) {
1054 if (sanp != start) {
1055 /* back up sanp one level */
1056 --sanp; /* now pointing at slash */
1057 while (sanp > start && sanp[-1] != '/')
1062 /* allow depth levels of .. at the beginning */
1064 /* move the virtual beginning to leave the .. alone */
1067 /* copy one component through next slash */
1068 while (*p && (*sanp++ = *p++) != '/') {}
1071 /* ended up with nothing, so put in "." component */
1079 /* Like chdir(), but it keeps track of the current directory (in the
1080 * global "curr_dir"), and ensures that the path size doesn't overflow.
1081 * Also cleans the path using the clean_fname() function. */
1082 int change_dir(const char *dir, int set_path_only)
1084 static int initialised, skipped_chdir;
1089 if (getcwd(curr_dir, sizeof curr_dir - 1) == NULL) {
1090 rsyserr(FERROR, errno, "getcwd()");
1091 exit_cleanup(RERR_FILESELECT);
1093 curr_dir_len = strlen(curr_dir);
1096 if (!dir) /* this call was probably just to initialize */
1100 if (len == 1 && *dir == '.' && (!skipped_chdir || set_path_only))
1104 if (len >= sizeof curr_dir) {
1105 errno = ENAMETOOLONG;
1108 if (!set_path_only && chdir(dir))
1110 skipped_chdir = set_path_only;
1111 memcpy(curr_dir, dir, len + 1);
1113 if (curr_dir_len + 1 + len >= sizeof curr_dir) {
1114 errno = ENAMETOOLONG;
1117 if (!(curr_dir_len && curr_dir[curr_dir_len-1] == '/'))
1118 curr_dir[curr_dir_len++] = '/';
1119 memcpy(curr_dir + curr_dir_len, dir, len + 1);
1121 if (!set_path_only && chdir(curr_dir)) {
1122 curr_dir[curr_dir_len] = '\0';
1125 skipped_chdir = set_path_only;
1128 curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1129 if (sanitize_paths) {
1130 if (module_dirlen > curr_dir_len)
1131 module_dirlen = curr_dir_len;
1132 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
1135 if (DEBUG_GTE(CHDIR, 1) && !set_path_only)
1136 rprintf(FINFO, "[%s] change_dir(%s)\n", who_am_i(), curr_dir);
1141 /* This will make a relative path absolute and clean it up via clean_fname().
1142 * Returns the string, which might be newly allocated, or NULL on error. */
1143 char *normalize_path(char *path, BOOL force_newbuf, unsigned int *len_ptr)
1147 if (*path != '/') { /* Make path absolute. */
1148 int len = strlen(path);
1149 if (curr_dir_len + 1 + len >= sizeof curr_dir)
1151 curr_dir[curr_dir_len] = '/';
1152 memcpy(curr_dir + curr_dir_len + 1, path, len + 1);
1153 if (!(path = strdup(curr_dir)))
1154 out_of_memory("normalize_path");
1155 curr_dir[curr_dir_len] = '\0';
1156 } else if (force_newbuf) {
1157 if (!(path = strdup(path)))
1158 out_of_memory("normalize_path");
1161 len = clean_fname(path, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1170 * Return a quoted string with the full pathname of the indicated filename.
1171 * The string " (in MODNAME)" may also be appended. The returned pointer
1172 * remains valid until the next time full_fname() is called.
1174 char *full_fname(const char *fn)
1176 static char *result = NULL;
1186 p1 = curr_dir + module_dirlen;
1187 for (p2 = p1; *p2 == '/'; p2++) {}
1191 if (module_id >= 0) {
1193 m2 = lp_name(module_id);
1198 if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) < 0)
1199 out_of_memory("full_fname");
1204 static char partial_fname[MAXPATHLEN];
1206 char *partial_dir_fname(const char *fname)
1208 char *t = partial_fname;
1209 int sz = sizeof partial_fname;
1212 if ((fn = strrchr(fname, '/')) != NULL) {
1214 if (*partial_dir != '/') {
1215 int len = fn - fname;
1216 strncpy(t, fname, len); /* safe */
1222 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
1224 if (daemon_filter_list.head) {
1225 t = strrchr(partial_fname, '/');
1227 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 1) < 0)
1230 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 0) < 0)
1234 return partial_fname;
1237 /* If no --partial-dir option was specified, we don't need to do anything
1238 * (the partial-dir is essentially '.'), so just return success. */
1239 int handle_partial_dir(const char *fname, int create)
1243 if (fname != partial_fname)
1245 if (!create && *partial_dir == '/')
1247 if (!(fn = strrchr(partial_fname, '/')))
1251 dir = partial_fname;
1254 int statret = do_lstat(dir, &st);
1255 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1256 if (do_unlink(dir) < 0) {
1262 if (statret < 0 && do_mkdir(dir, 0700) < 0) {
1273 /* Determine if a symlink points outside the current directory tree.
1274 * This is considered "unsafe" because e.g. when mirroring somebody
1275 * else's machine it might allow them to establish a symlink to
1276 * /etc/passwd, and then read it through a web server.
1278 * Returns 1 if unsafe, 0 if safe.
1280 * Null symlinks and absolute symlinks are always unsafe.
1282 * Basically here we are concerned with symlinks whose target contains
1283 * "..", because this might cause us to walk back up out of the
1284 * transferred directory. We are not allowed to go back up and
1287 * "dest" is the target of the symlink in question.
1289 * "src" is the top source directory currently applicable at the level
1290 * of the referenced symlink. This is usually the symlink's full path
1291 * (including its name), as referenced from the root of the transfer. */
1292 int unsafe_symlink(const char *dest, const char *src)
1294 const char *name, *slash;
1297 /* all absolute and null symlinks are unsafe */
1298 if (!dest || !*dest || *dest == '/')
1301 /* find out what our safety margin is */
1302 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1303 /* ".." segment starts the count over. "." segment is ignored. */
1304 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1309 while (slash[1] == '/') slash++; /* just in case src isn't clean */
1311 if (*name == '.' && name[1] == '.' && name[2] == '\0')
1314 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1315 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1316 if (name[1] == '.') {
1317 /* if at any point we go outside the current directory
1318 then stop - it is unsafe */
1324 while (slash[1] == '/') slash++;
1326 if (*name == '.' && name[1] == '.' && name[2] == '\0')
1332 /* Return the date and time as a string. Some callers tweak returned buf. */
1333 char *timestring(time_t t)
1335 static char TimeBuf[200];
1336 struct tm *tm = localtime(&t);
1339 #ifdef HAVE_STRFTIME
1340 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1342 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1345 if ((p = strchr(TimeBuf, '\n')) != NULL)
1351 /* Determine if two time_t values are equivalent (either exact, or in
1352 * the modification timestamp window established by --modify-window).
1354 * @retval 0 if the times should be treated as the same
1356 * @retval +1 if the first is later
1358 * @retval -1 if the 2nd is later
1360 int cmp_time(time_t f1_sec, unsigned long f1_nsec, time_t f2_sec, unsigned long f2_nsec)
1362 if (f2_sec > f1_sec) {
1363 /* The final comparison makes sure that modify_window doesn't overflow a
1364 * time_t, which would mean that f2_sec must be in the equality window. */
1365 if (modify_window <= 0 || (f2_sec > f1_sec + modify_window && f1_sec + modify_window > f1_sec))
1367 } else if (f1_sec > f2_sec) {
1368 if (modify_window <= 0 || (f1_sec > f2_sec + modify_window && f2_sec + modify_window > f2_sec))
1370 } else if (modify_window < 0) {
1371 if (f2_nsec > f1_nsec)
1373 else if (f1_nsec > f2_nsec)
1383 This routine is a trick to immediately catch errors when debugging
1384 with insure. A xterm with a gdb is popped up when insure catches
1385 a error. It is Linux specific.
1387 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1390 int ret, pid_int = getpid();
1394 "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; "
1395 "gdb /proc/%d/exe %d'", pid_int, pid_int, pid_int) < 0)
1400 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1401 fn = dlsym(h, "_Insure_trap_error");
1404 ret = fn(a1, a2, a3, a4, a5, a6);
1414 /* Take a filename and filename length and return the most significant
1415 * filename suffix we can find. This ignores suffixes such as "~",
1416 * ".bak", ".orig", ".~1~", etc. */
1417 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1419 const char *suf, *s;
1423 /* One or more dots at the start aren't a suffix. */
1424 while (fn_len && *fn == '.') fn++, fn_len--;
1426 /* Ignore the ~ in a "foo~" filename. */
1427 if (fn_len > 1 && fn[fn_len-1] == '~')
1428 fn_len--, had_tilde = True;
1432 /* Assume we don't find an suffix. */
1436 /* Find the last significant suffix. */
1437 for (s = fn + fn_len; fn_len > 1; ) {
1438 while (*--s != '.' && s != fn) {}
1441 s_len = fn_len - (s - fn);
1444 if (strcmp(s+1, "bak") == 0
1445 || strcmp(s+1, "old") == 0)
1447 } else if (s_len == 5) {
1448 if (strcmp(s+1, "orig") == 0)
1450 } else if (s_len > 2 && had_tilde
1451 && s[1] == '~' && isDigit(s + 2))
1457 /* Determine if the suffix is all digits. */
1458 for (s++, s_len--; s_len > 0; s++, s_len--) {
1462 /* An all-digit suffix may not be that signficant. */
1469 /* This is an implementation of the Levenshtein distance algorithm. It
1470 * was implemented to avoid needing a two-dimensional matrix (to save
1471 * memory). It was also tweaked to try to factor in the ASCII distance
1472 * between changed characters as a minor distance quantity. The normal
1473 * Levenshtein units of distance (each signifying a single change between
1474 * the two strings) are defined as a "UNIT". */
1476 #define UNIT (1 << 16)
1478 uint32 fuzzy_distance(const char *s1, unsigned len1, const char *s2, unsigned len2)
1480 uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1484 if (!len1 || !len2) {
1489 for (i1 = 0, cost = 0; i1 < len1; i1++)
1491 return (int32)len1 * UNIT + cost;
1494 for (i2 = 0; i2 < len2; i2++)
1495 a[i2] = (i2+1) * UNIT;
1497 for (i1 = 0; i1 < len1; i1++) {
1499 above = (i1+1) * UNIT;
1500 for (i2 = 0; i2 < len2; i2++) {
1502 if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1508 diag_inc = diag + cost;
1509 left_inc = left + UNIT + *((uchar*)s1+i1);
1510 above_inc = above + UNIT + *((uchar*)s2+i2);
1511 a[i2] = above = left < above
1512 ? (left_inc < diag_inc ? left_inc : diag_inc)
1513 : (above_inc < diag_inc ? above_inc : diag_inc);
1521 #define BB_SLOT_SIZE (16*1024) /* Desired size in bytes */
1522 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1523 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1530 struct bitbag *bitbag_create(int max_ndx)
1532 struct bitbag *bb = new(struct bitbag);
1533 bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1535 if (!(bb->bits = (uint32**)calloc(bb->slot_cnt, sizeof (uint32*))))
1536 out_of_memory("bitbag_create");
1541 void bitbag_set_bit(struct bitbag *bb, int ndx)
1543 int slot = ndx / BB_PER_SLOT_BITS;
1544 ndx %= BB_PER_SLOT_BITS;
1546 if (!bb->bits[slot]) {
1547 if (!(bb->bits[slot] = (uint32*)calloc(BB_PER_SLOT_INTS, 4)))
1548 out_of_memory("bitbag_set_bit");
1551 bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1554 #if 0 /* not needed yet */
1555 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1557 int slot = ndx / BB_PER_SLOT_BITS;
1558 ndx %= BB_PER_SLOT_BITS;
1560 if (!bb->bits[slot])
1563 bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1566 int bitbag_check_bit(struct bitbag *bb, int ndx)
1568 int slot = ndx / BB_PER_SLOT_BITS;
1569 ndx %= BB_PER_SLOT_BITS;
1571 if (!bb->bits[slot])
1574 return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1578 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
1579 int bitbag_next_bit(struct bitbag *bb, int after)
1582 int i, ndx = after + 1;
1583 int slot = ndx / BB_PER_SLOT_BITS;
1584 ndx %= BB_PER_SLOT_BITS;
1586 mask = (1u << (ndx % 32)) - 1;
1587 for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1588 if (!bb->bits[slot])
1590 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1591 if (!(bits = bb->bits[slot][i] & ~mask))
1593 /* The xor magic figures out the lowest enabled bit in
1594 * bits, and the switch quickly computes log2(bit). */
1595 switch (bits ^ (bits & (bits-1))) {
1596 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1597 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
1598 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
1599 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
1600 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1601 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1602 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1603 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1604 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1606 return -1; /* impossible... */
1613 void flist_ndx_push(flist_ndx_list *lp, int ndx)
1615 struct flist_ndx_item *item;
1617 if (!(item = new(struct flist_ndx_item)))
1618 out_of_memory("flist_ndx_push");
1622 lp->tail->next = item;
1628 int flist_ndx_pop(flist_ndx_list *lp)
1630 struct flist_ndx_item *next;
1636 ndx = lp->head->ndx;
1637 next = lp->head->next;
1646 /* Make sure there is room for one more item in the item list. If there
1647 * is not, expand the list as indicated by the value of "incr":
1648 * - if incr < 0 then increase the malloced size by -1 * incr
1649 * - if incr >= 0 then either make the malloced size equal to "incr"
1650 * or (if that's not large enough) double the malloced size
1651 * After the size check, the list's count is incremented by 1 and a pointer
1652 * to the "new" list item is returned.
1654 void *expand_item_list(item_list *lp, size_t item_size,
1655 const char *desc, int incr)
1657 /* First time through, 0 <= 0, so list is expanded. */
1658 if (lp->malloced <= lp->count) {
1660 size_t new_size = lp->malloced;
1662 new_size += -incr; /* increase slowly */
1663 else if (new_size < (size_t)incr)
1669 if (new_size <= lp->malloced)
1670 overflow_exit("expand_item_list");
1671 /* Using _realloc_array() lets us pass the size, not a type. */
1672 new_ptr = _realloc_array(lp->items, item_size, new_size);
1673 if (DEBUG_GTE(FLIST, 3)) {
1674 rprintf(FINFO, "[%s] expand %s to %s bytes, did%s move\n",
1675 who_am_i(), desc, big_num(new_size * item_size),
1676 new_ptr == lp->items ? " not" : "");
1679 out_of_memory("expand_item_list");
1681 lp->items = new_ptr;
1682 lp->malloced = new_size;
1684 return (char*)lp->items + (lp->count++ * item_size);
1687 /* This zeroing of memory won't be optimized away by the compiler. */
1688 void force_memzero(void *buf, size_t len)
1690 volatile uchar *z = buf;