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-2022 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.
31 extern int protect_args;
32 extern int modify_window;
33 extern int relative_paths;
34 extern int preserve_xattrs;
35 extern int omit_link_times;
36 extern int preallocate_files;
37 extern char *module_dir;
38 extern unsigned int module_dirlen;
39 extern char *partial_dir;
40 extern filter_rule_list daemon_filter_list;
42 int sanitize_paths = 0;
44 char curr_dir[MAXPATHLEN];
45 unsigned int curr_dir_len;
46 int curr_dir_depth; /* This is only set for a sanitizing daemon. */
48 /* Set a fd into nonblocking mode. */
49 void set_nonblocking(int fd)
53 if ((val = fcntl(fd, F_GETFL)) == -1)
55 if (!(val & NONBLOCK_FLAG)) {
57 fcntl(fd, F_SETFL, val);
61 /* Set a fd into blocking mode. */
62 void set_blocking(int fd)
66 if ((val = fcntl(fd, F_GETFL)) == -1)
68 if (val & NONBLOCK_FLAG) {
69 val &= ~NONBLOCK_FLAG;
70 fcntl(fd, F_SETFL, val);
75 * Create a file descriptor pair - like pipe() but use socketpair if
76 * possible (because of blocking issues on pipes).
78 * Always set non-blocking.
80 int fd_pair(int fd[2])
84 #ifdef HAVE_SOCKETPAIR
85 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
91 set_nonblocking(fd[0]);
92 set_nonblocking(fd[1]);
98 void print_child_argv(const char *prefix, char **cmd)
101 rprintf(FCLIENT, "%s ", prefix);
102 for (; *cmd; cmd++) {
103 /* Look for characters that ought to be quoted. This
104 * is not a great quoting algorithm, but it's
105 * sufficient for a log message. */
106 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
107 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
109 ",.-_=+@/") != strlen(*cmd)) {
110 rprintf(FCLIENT, "\"%s\" ", *cmd);
112 rprintf(FCLIENT, "%s ", *cmd);
116 rprintf(FCLIENT, " (%d args)\n", cnt);
119 /* This returns 0 for success, 1 for a symlink if symlink time-setting
120 * is not possible, or -1 for any other error. */
121 int set_times(const char *fname, STRUCT_STAT *stp)
123 static int switch_step = 0;
125 if (DEBUG_GTE(TIME, 1)) {
127 "set modtime, atime of %s to (%ld) %s, (%ld) %s\n",
128 fname, (long)stp->st_mtime,
129 timestring(stp->st_mtime), (long)stp->st_atime, timestring(stp->st_atime));
132 switch (switch_step) {
133 #ifdef HAVE_SETATTRLIST
135 if (do_setattrlist_times(fname, stp) == 0)
142 #ifdef HAVE_UTIMENSAT
144 if (do_utimensat(fname, stp) == 0)
153 if (do_lutimes(fname, stp) == 0)
162 if (!omit_link_times) {
164 if (S_ISLNK(stp->st_mode))
170 if (do_utimes(fname, stp) == 0)
173 if (do_utime(fname, stp) == 0)
183 /* Create any necessary directories in fname. Any missing directories are
184 * created with default permissions. Returns < 0 on error, or the number
185 * of directories created. */
186 int make_path(char *fname, int flags)
191 if (flags & MKP_SKIP_SLASH) {
192 while (*fname == '/')
196 while (*fname == '.' && fname[1] == '/')
199 if (flags & MKP_DROP_NAME) {
200 end = strrchr(fname, '/');
201 if (!end || end == fname)
205 end = fname + strlen(fname);
207 /* Try to find an existing dir, starting from the deepest dir. */
211 if (do_stat(fname, &st) == 0) {
212 if (S_ISDIR(st.st_mode))
217 } else if (do_mkdir(fname, ACCESSPERMS) == 0) {
222 if (errno != ENOENT) {
224 if (errno != EEXIST || (do_stat(fname, &st) == 0 && !S_ISDIR(st.st_mode)))
230 /* We got a relative path that doesn't exist, so assume that '.'
231 * is there and just break out and create the whole thing. */
237 /* We reached the "/" dir, which we assume is there. */
247 /* Make all the dirs that we didn't find on the way here. */
254 if (ret < 0) /* Skip mkdir on error, but keep restoring the path. */
256 if (do_mkdir(fname, ACCESSPERMS) < 0)
262 if (flags & MKP_DROP_NAME)
269 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
272 * @retval len upon success
274 * @retval <0 write's (negative) error code
276 * Derived from GNU C's cccp.c.
278 int full_write(int desc, const char *ptr, size_t len)
284 int written = write(desc, ptr, len);
290 total_written += written;
294 return total_written;
298 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
301 * @retval >0 the actual number of bytes read
305 * @retval <0 for an error.
307 * Derived from GNU C's cccp.c. */
308 static int safe_read(int desc, char *ptr, size_t len)
316 n_chars = read(desc, ptr, len);
317 } while (n_chars < 0 && errno == EINTR);
322 /* Remove existing file @dest and reopen, creating a new file with @mode */
323 static int unlink_and_reopen(const char *dest, mode_t mode)
327 if (robust_unlink(dest) && errno != ENOENT) {
328 int save_errno = errno;
329 rsyserr(FERROR_XFER, errno, "unlink %s", full_fname(dest));
334 #ifdef SUPPORT_XATTRS
338 mode &= INITACCESSPERMS;
339 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0) {
340 int save_errno = errno;
341 rsyserr(FERROR_XFER, save_errno, "open %s", full_fname(dest));
348 /* Copy contents of file @source to file @dest with mode @mode.
350 * If @tmpfilefd is < 0, copy_file unlinks @dest and then opens a new
351 * file with name @dest.
353 * Otherwise, copy_file writes to and closes the provided file
356 * In either case, if --xattrs are being preserved, the dest file will
357 * have its xattrs set from the source file.
359 * This is used in conjunction with the --temp-dir, --backup, and
360 * --copy-dest options. */
361 int copy_file(const char *source, const char *dest, int tmpfilefd, mode_t mode)
365 int len; /* Number of bytes read into `buf'. */
366 OFF_T prealloc_len = 0, offset = 0;
368 if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
369 int save_errno = errno;
370 rsyserr(FERROR_XFER, errno, "open %s", full_fname(source));
375 if (tmpfilefd >= 0) {
378 ofd = unlink_and_reopen(dest, mode);
380 int save_errno = errno;
387 #ifdef SUPPORT_PREALLOCATION
388 if (preallocate_files) {
391 /* Try to preallocate enough space for file's eventual length. Can
392 * reduce fragmentation on filesystems like ext4, xfs, and NTFS. */
393 if (do_fstat(ifd, &srcst) < 0)
394 rsyserr(FWARNING, errno, "fstat %s", full_fname(source));
395 else if (srcst.st_size > 0) {
396 prealloc_len = do_fallocate(ofd, 0, srcst.st_size);
397 if (prealloc_len < 0)
398 rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(dest));
403 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
404 if (full_write(ofd, buf, len) < 0) {
405 int save_errno = errno;
406 rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
416 int save_errno = errno;
417 rsyserr(FERROR_XFER, errno, "read %s", full_fname(source));
424 if (close(ifd) < 0) {
425 rsyserr(FWARNING, errno, "close failed on %s",
429 /* Source file might have shrunk since we fstatted it.
430 * Cut off any extra preallocated zeros from dest file. */
431 if (offset < prealloc_len) {
432 #ifdef HAVE_FTRUNCATE
433 /* If we fail to truncate, the dest file may be wrong, so we
434 * must trigger the "partial transfer" error. */
435 if (do_ftruncate(ofd, offset) < 0)
436 rsyserr(FERROR_XFER, errno, "ftruncate %s", full_fname(dest));
438 rprintf(FERROR_XFER, "no ftruncate for over-long pre-alloc: %s", full_fname(dest));
442 if (do_fsync && fsync(ofd) < 0) {
443 int save_errno = errno;
444 rsyserr(FERROR, errno, "fsync failed on %s", full_fname(dest));
450 if (close(ofd) < 0) {
451 int save_errno = errno;
452 rsyserr(FERROR_XFER, errno, "close failed on %s", full_fname(dest));
457 #ifdef SUPPORT_XATTRS
459 copy_xattrs(source, dest);
465 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
466 #define MAX_RENAMES_DIGITS 3
467 #define MAX_RENAMES 1000
470 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
471 * rename to <path>/.rsyncNNN instead.
473 * Note that successive rsync runs will shuffle the filenames around a
474 * bit as long as the file is still busy; this is because this function
475 * does not know if the unlink call is due to a new file coming in, or
476 * --delete trying to remove old .rsyncNNN files, hence it renames it
479 int robust_unlink(const char *fname)
482 return do_unlink(fname);
484 static int counter = 1;
486 char path[MAXPATHLEN];
488 rc = do_unlink(fname);
489 if (rc == 0 || errno != ETXTBSY)
492 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
493 pos = MAXPATHLEN - 1;
495 while (pos > 0 && path[pos-1] != '/')
497 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
499 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
504 /* start where the last one left off to reduce chance of clashes */
507 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
508 if (++counter >= MAX_RENAMES)
510 } while ((rc = access(path, 0)) == 0 && counter != start);
512 if (INFO_GTE(MISC, 1)) {
513 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
517 /* maybe we should return rename()'s exit status? Nah. */
518 if (do_rename(fname, path) != 0) {
526 /* Returns 0 on successful rename, 1 if we successfully copied the file
527 * across filesystems, -2 if copy_file() failed, and -1 on other errors.
528 * If partialptr is not NULL and we need to do a copy, copy the file into
529 * the active partial-dir instead of over the destination file. */
530 int robust_rename(const char *from, const char *to, const char *partialptr,
535 /* A resumed in-place partial-dir transfer might call us with from and
536 * to pointing to the same buf if the transfer failed yet again. */
541 if (do_rename(from, to) == 0)
547 if (robust_unlink(to) != 0) {
556 if (!handle_partial_dir(partialptr,PDIR_CREATE))
560 if (copy_file(from, to, -1, mode) != 0)
571 static pid_t all_pids[10];
574 /** Fork and record the pid of the child. **/
577 pid_t newpid = fork();
579 if (newpid != 0 && newpid != -1) {
580 all_pids[num_pids++] = newpid;
588 * @todo It would be kind of nice to make sure that they are actually
589 * all our children before we kill them, because their pids may have
590 * been recycled by some other process. Perhaps when we wait for a
591 * child, we should remove it from this array. Alternatively we could
592 * perhaps use process groups, but I think that would not work on
593 * ancient Unix versions that don't support them.
595 void kill_all(int sig)
599 for (i = 0; i < num_pids; i++) {
600 /* Let's just be a little careful where we
601 * point that gun, hey? See kill(2) for the
602 * magic caused by negative values. */
603 pid_t p = all_pids[i];
614 /** Lock a byte range in a open file */
615 int lock_range(int fd, int offset, int len)
619 lock.l_type = F_WRLCK;
620 lock.l_whence = SEEK_SET;
621 lock.l_start = offset;
625 return fcntl(fd,F_SETLK,&lock) == 0;
628 #define ENSURE_MEMSPACE(buf, type, sz, req) \
629 do { if ((req) > sz) buf = realloc_array(buf, type, sz = MAX(sz * 2, req)); } while(0)
631 static inline void call_glob_match(const char *name, int len, int from_glob,
632 char *arg, int abpos, int fbpos);
634 static struct glob_data {
635 char *arg_buf, *filt_buf, **argv;
636 int absize, fbsize, maxargs, argc;
639 static void glob_match(char *arg, int abpos, int fbpos)
644 while (*arg == '.' && arg[1] == '/') {
646 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, glob.absize);
647 memcpy(glob.filt_buf, glob.arg_buf, abpos + 1);
650 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + 3);
651 glob.arg_buf[abpos++] = *arg++;
652 glob.arg_buf[abpos++] = *arg++;
653 glob.arg_buf[abpos] = '\0';
655 if ((slash = strchr(arg, '/')) != NULL) {
660 if (strpbrk(arg, "*?[")) {
664 if (!(d = opendir(abpos ? glob.arg_buf : ".")))
666 while ((di = readdir(d)) != NULL) {
667 char *dname = d_name(di);
668 if (dname[0] == '.' && (dname[1] == '\0'
669 || (dname[1] == '.' && dname[2] == '\0')))
671 if (!wildmatch(arg, dname))
673 call_glob_match(dname, strlen(dname), 1,
674 slash ? arg + len + 1 : NULL,
679 call_glob_match(arg, len, 0,
680 slash ? arg + len + 1 : NULL,
687 static inline void call_glob_match(const char *name, int len, int from_glob,
688 char *arg, int abpos, int fbpos)
692 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + len + 2);
693 memcpy(glob.arg_buf + abpos, name, len);
695 glob.arg_buf[abpos] = '\0';
698 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, fbpos + len + 2);
699 memcpy(glob.filt_buf + fbpos, name, len);
701 glob.filt_buf[fbpos] = '\0';
702 use_buf = glob.filt_buf;
704 use_buf = glob.arg_buf;
706 if (from_glob || (arg && len)) {
710 if (do_stat(glob.arg_buf, &st) != 0)
712 is_dir = S_ISDIR(st.st_mode) != 0;
716 if (daemon_filter_list.head
717 && check_filter(&daemon_filter_list, FLOG, use_buf, is_dir) < 0)
722 glob.arg_buf[abpos++] = '/';
723 glob.arg_buf[abpos] = '\0';
725 glob.filt_buf[fbpos++] = '/';
726 glob.filt_buf[fbpos] = '\0';
728 glob_match(arg, abpos, fbpos);
730 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
731 glob.argv[glob.argc++] = strdup(glob.arg_buf);
735 /* This routine performs wild-card expansion of the pathname in "arg". Any
736 * daemon-excluded files/dirs will not be matched by the wildcards. Returns 0
737 * if a wild-card string is the only returned item (due to matching nothing). */
738 int glob_expand(const char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
747 memset(&glob, 0, sizeof glob);
752 s = sanitize_path(NULL, arg, "", 0, SP_KEEP_DOT_DIRS);
755 clean_fname(s, CFN_KEEP_DOT_DIRS | CFN_KEEP_TRAILING_SLASH | CFN_COLLAPSE_DOT_DOT_DIRS);
758 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, MAXPATHLEN);
759 *glob.arg_buf = '\0';
761 glob.argc = save_argc = *argc_p;
763 glob.maxargs = *maxargs_p;
765 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, 100);
767 glob_match(s, 0, -1);
769 /* The arg didn't match anything, so add the failed arg to the list. */
770 if (glob.argc == save_argc) {
771 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
772 glob.argv[glob.argc++] = s;
779 *maxargs_p = glob.maxargs;
786 /* This routine is only used in daemon mode. */
787 void glob_expand_module(char *base1, char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
791 int base_len = strlen(base);
796 if (strncmp(arg, base, base_len) == 0)
800 glob_expand(arg, argv_p, argc_p, maxargs_p);
806 if (asprintf(&base," %s/", base1) < 0)
807 out_of_memory("glob_expand_module");
810 for (s = arg; *s; s = p + base_len) {
811 if ((p = strstr(s, base)) != NULL)
812 *p = '\0'; /* split it at this point */
813 glob_expand(s, argv_p, argc_p, maxargs_p);
823 * Convert a string to lower case
825 void strlower(char *s)
835 * Split a string into tokens based (usually) on whitespace & commas. If the
836 * string starts with a comma (after skipping any leading whitespace), then
837 * splitting is done only on commas. No empty tokens are ever returned. */
838 char *conf_strtok(char *str)
840 static int commas_only = 0;
843 while (isSpace(str)) str++;
851 while (commas_only) {
852 char *end, *tok = strtok(str, ",");
855 /* Trim just leading and trailing whitespace. */
858 end = tok + strlen(tok);
859 while (end > tok && isSpace(end-1))
866 return strtok(str, " ,\t\r\n");
869 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
870 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
871 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
872 * string fits into destsize. */
873 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
875 size_t len = strlcpy(dest, p1, destsize);
876 if (len < destsize - 1) {
877 if (!len || dest[len-1] != '/')
879 if (len < destsize - 1)
880 len += strlcpy(dest + len, p2, destsize - len);
887 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
891 /* Join any number of strings together, putting them in "dest". The return
892 * value is the length of all the strings, regardless of whether the null-
893 * terminated whole fits in destsize. Your list of string pointers must end
894 * with a NULL to indicate the end of the list. */
895 size_t stringjoin(char *dest, size_t destsize, ...)
901 va_start(ap, destsize);
903 if (!(src = va_arg(ap, const char *)))
910 memcpy(dest, src, len);
921 int count_dir_elements(const char *p)
923 int cnt = 0, new_component = 1;
926 new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
927 else if (new_component) {
935 /* Turns multiple adjacent slashes into a single slash (possible exception:
936 * the preserving of two leading slashes at the start), drops all leading or
937 * interior "." elements unless CFN_KEEP_DOT_DIRS is flagged. Will also drop
938 * a trailing '.' after a '/' if CFN_DROP_TRAILING_DOT_DIR is flagged, removes
939 * a trailing slash (perhaps after removing the aforementioned dot) unless
940 * CFN_KEEP_TRAILING_SLASH is flagged, and will also collapse ".." elements
941 * (except at the start) if CFN_COLLAPSE_DOT_DOT_DIRS is flagged. If the
942 * resulting name would be empty, returns ".". */
943 int clean_fname(char *name, int flags)
945 char *limit = name - 1, *t = name, *f = name;
951 #define DOT_IS_DOT_DOT_DIR(bp) (bp[1] == '.' && (bp[2] == '/' || !bp[2]))
953 if ((anchored = *f == '/') != 0) {
956 /* If there are exactly 2 slashes at the start, preserve
957 * them. Would break daemon excludes unless the paths are
958 * really treated differently, so used this sparingly. */
959 if (*f == '/' && f[1] != '/')
962 } else if (flags & CFN_KEEP_DOT_DIRS && *f == '.' && f[1] == '/') {
965 } else if (flags & CFN_REFUSE_DOT_DOT_DIRS && *f == '.' && DOT_IS_DOT_DOT_DIR(f))
968 /* discard extra slashes */
974 /* discard interior "." dirs */
975 if (f[1] == '/' && !(flags & CFN_KEEP_DOT_DIRS)) {
979 if (f[1] == '\0' && flags & CFN_DROP_TRAILING_DOT_DIR)
981 /* collapse ".." dirs */
982 if (flags & (CFN_COLLAPSE_DOT_DOT_DIRS|CFN_REFUSE_DOT_DOT_DIRS) && DOT_IS_DOT_DOT_DIR(f)) {
984 if (flags & CFN_REFUSE_DOT_DOT_DIRS)
986 if (s == name && anchored) {
990 while (s > limit && *--s != '/') {}
991 if (s != t - 1 && (s < name || *s == '/')) {
999 while (*f && (*t++ = *f++) != '/') {}
1002 if (t > name+anchored && t[-1] == '/' && !(flags & CFN_KEEP_TRAILING_SLASH))
1008 #undef DOT_IS_DOT_DOT_DIR
1013 /* Make path appear as if a chroot had occurred. This handles a leading
1014 * "/" (either removing it or expanding it) and any leading or embedded
1015 * ".." components that attempt to escape past the module's top dir.
1017 * If dest is NULL, a buffer is allocated to hold the result. It is legal
1018 * to call with the dest and the path (p) pointing to the same buffer, but
1019 * rootdir will be ignored to avoid expansion of the string.
1021 * The rootdir string contains a value to use in place of a leading slash.
1022 * Specify NULL to get the default of "module_dir".
1024 * The depth var is a count of how many '..'s to allow at the start of the
1027 * We also clean the path in a manner similar to clean_fname() but with a
1030 * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
1031 * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
1032 * ALWAYS collapses ".." elements (except for those at the start of the
1033 * string up to "depth" deep). If the resulting name would be empty,
1034 * change it into a ".". */
1035 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth, int flags)
1038 int rlen = 0, drop_dot_dirs = !relative_paths || !(flags & SP_KEEP_DOT_DIRS);
1041 int plen = strlen(p); /* the path len INCLUDING any separating slash */
1044 rootdir = module_dir;
1045 rlen = strlen(rootdir);
1050 dest = new_array(char, MAX(rlen + plen + 1, 2));
1051 else if (rlen + plen + 1 >= MAXPATHLEN)
1053 if (rlen) { /* only true if p previously started with a slash */
1054 memcpy(dest, rootdir, rlen);
1055 if (rlen > 1) /* a rootdir of len 1 is "/", so this avoids a 2nd slash */
1060 if (drop_dot_dirs) {
1061 while (*p == '.' && p[1] == '/')
1065 start = sanp = dest + rlen;
1066 /* This loop iterates once per filename component in p, pointing at
1067 * the start of the name (past any prior slash) for each iteration. */
1069 /* discard leading or extra slashes */
1074 if (drop_dot_dirs) {
1075 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
1076 /* skip "." component */
1081 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
1082 /* ".." component followed by slash or end */
1083 if (depth <= 0 || sanp != start) {
1085 if (sanp != start) {
1086 /* back up sanp one level */
1087 --sanp; /* now pointing at slash */
1088 while (sanp > start && sanp[-1] != '/')
1093 /* allow depth levels of .. at the beginning */
1095 /* move the virtual beginning to leave the .. alone */
1098 /* copy one component through next slash */
1099 while (*p && (*sanp++ = *p++) != '/') {}
1102 /* ended up with nothing, so put in "." component */
1110 /* Like chdir(), but it keeps track of the current directory (in the
1111 * global "curr_dir"), and ensures that the path size doesn't overflow.
1112 * Also cleans the path using the clean_fname() function. */
1113 int change_dir(const char *dir, int set_path_only)
1115 static int initialised, skipped_chdir;
1120 if (getcwd(curr_dir, sizeof curr_dir - 1) == NULL) {
1121 rsyserr(FERROR, errno, "getcwd()");
1122 exit_cleanup(RERR_FILESELECT);
1124 curr_dir_len = strlen(curr_dir);
1127 if (!dir) /* this call was probably just to initialize */
1131 if (len == 1 && *dir == '.' && (!skipped_chdir || set_path_only))
1135 if (len >= sizeof curr_dir) {
1136 errno = ENAMETOOLONG;
1139 if (!set_path_only && chdir(dir))
1141 skipped_chdir = set_path_only;
1142 memcpy(curr_dir, dir, len + 1);
1144 unsigned int save_dir_len = curr_dir_len;
1145 if (curr_dir_len + 1 + len >= sizeof curr_dir) {
1146 errno = ENAMETOOLONG;
1149 if (!(curr_dir_len && curr_dir[curr_dir_len-1] == '/'))
1150 curr_dir[curr_dir_len++] = '/';
1151 memcpy(curr_dir + curr_dir_len, dir, len + 1);
1153 if (!set_path_only && chdir(curr_dir)) {
1154 curr_dir_len = save_dir_len;
1155 curr_dir[curr_dir_len] = '\0';
1158 skipped_chdir = set_path_only;
1161 curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1162 if (sanitize_paths) {
1163 if (module_dirlen > curr_dir_len)
1164 module_dirlen = curr_dir_len;
1165 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
1168 if (DEBUG_GTE(CHDIR, 1) && !set_path_only)
1169 rprintf(FINFO, "[%s] change_dir(%s)\n", who_am_i(), curr_dir);
1174 /* This will make a relative path absolute and clean it up via clean_fname().
1175 * Returns the string, which might be newly allocated, or NULL on error. */
1176 char *normalize_path(char *path, BOOL force_newbuf, unsigned int *len_ptr)
1180 if (*path != '/') { /* Make path absolute. */
1181 int len = strlen(path);
1182 if (curr_dir_len + 1 + len >= sizeof curr_dir)
1184 curr_dir[curr_dir_len] = '/';
1185 memcpy(curr_dir + curr_dir_len + 1, path, len + 1);
1186 path = strdup(curr_dir);
1187 curr_dir[curr_dir_len] = '\0';
1188 } else if (force_newbuf)
1189 path = strdup(path);
1191 len = clean_fname(path, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1200 * Return a quoted string with the full pathname of the indicated filename.
1201 * The string " (in MODNAME)" may also be appended. The returned pointer
1202 * remains valid until the next time full_fname() is called.
1204 char *full_fname(const char *fn)
1206 static char *result = NULL;
1216 p1 = curr_dir + module_dirlen;
1217 for (p2 = p1; *p2 == '/'; p2++) {}
1221 if (module_id >= 0) {
1223 m2 = lp_name(module_id);
1228 if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) < 0)
1229 out_of_memory("full_fname");
1234 static char partial_fname[MAXPATHLEN];
1236 char *partial_dir_fname(const char *fname)
1238 char *t = partial_fname;
1239 int sz = sizeof partial_fname;
1242 if ((fn = strrchr(fname, '/')) != NULL) {
1244 if (*partial_dir != '/') {
1245 int len = fn - fname;
1246 strncpy(t, fname, len); /* safe */
1252 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
1254 if (daemon_filter_list.head) {
1255 t = strrchr(partial_fname, '/');
1257 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 1) < 0)
1260 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 0) < 0)
1264 return partial_fname;
1267 /* If no --partial-dir option was specified, we don't need to do anything
1268 * (the partial-dir is essentially '.'), so just return success. */
1269 int handle_partial_dir(const char *fname, int create)
1273 if (fname != partial_fname)
1275 if (!create && *partial_dir == '/')
1277 if (!(fn = strrchr(partial_fname, '/')))
1281 dir = partial_fname;
1284 int statret = do_lstat(dir, &st);
1285 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1286 if (do_unlink(dir) < 0) {
1292 if (statret < 0 && do_mkdir(dir, 0700) < 0) {
1303 /* Determine if a symlink points outside the current directory tree.
1304 * This is considered "unsafe" because e.g. when mirroring somebody
1305 * else's machine it might allow them to establish a symlink to
1306 * /etc/passwd, and then read it through a web server.
1308 * Returns 1 if unsafe, 0 if safe.
1310 * Null symlinks and absolute symlinks are always unsafe.
1312 * Basically here we are concerned with symlinks whose target contains
1313 * "..", because this might cause us to walk back up out of the
1314 * transferred directory. We are not allowed to go back up and
1317 * "dest" is the target of the symlink in question.
1319 * "src" is the top source directory currently applicable at the level
1320 * of the referenced symlink. This is usually the symlink's full path
1321 * (including its name), as referenced from the root of the transfer. */
1322 int unsafe_symlink(const char *dest, const char *src)
1324 const char *name, *slash;
1327 /* all absolute and null symlinks are unsafe */
1328 if (!dest || !*dest || *dest == '/')
1331 /* find out what our safety margin is */
1332 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1333 /* ".." segment starts the count over. "." segment is ignored. */
1334 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1339 while (slash[1] == '/') slash++; /* just in case src isn't clean */
1341 if (*name == '.' && name[1] == '.' && name[2] == '\0')
1344 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1345 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1346 if (name[1] == '.') {
1347 /* if at any point we go outside the current directory
1348 then stop - it is unsafe */
1354 while (slash[1] == '/') slash++;
1356 if (*name == '.' && name[1] == '.' && name[2] == '\0')
1362 /* Return the date and time as a string. Some callers tweak returned buf. */
1363 char *timestring(time_t t)
1366 static char buffers[4][20]; /* We support 4 simultaneous timestring results. */
1367 char *TimeBuf = buffers[ndx = (ndx + 1) % 4];
1368 struct tm *tm = localtime(&t);
1369 int len = snprintf(TimeBuf, sizeof buffers[0], "%4d/%02d/%02d %02d:%02d:%02d",
1370 (int)tm->tm_year + 1900, (int)tm->tm_mon + 1, (int)tm->tm_mday,
1371 (int)tm->tm_hour, (int)tm->tm_min, (int)tm->tm_sec);
1372 assert(len > 0); /* Silence gcc warning */
1377 /* Determine if two time_t values are equivalent (either exact, or in
1378 * the modification timestamp window established by --modify-window).
1379 * Returns 1 if the times the "same", or 0 if they are different. */
1380 int same_time(time_t f1_sec, unsigned long f1_nsec, time_t f2_sec, unsigned long f2_nsec)
1382 if (modify_window == 0)
1383 return f1_sec == f2_sec;
1384 if (modify_window < 0)
1385 return f1_sec == f2_sec && f1_nsec == f2_nsec;
1386 /* The nanoseconds do not figure into these checks -- time windows don't care about that. */
1387 if (f2_sec > f1_sec)
1388 return f2_sec - f1_sec <= modify_window;
1389 return f1_sec - f2_sec <= modify_window;
1396 This routine is a trick to immediately catch errors when debugging
1397 with insure. A xterm with a gdb is popped up when insure catches
1398 a error. It is Linux specific.
1400 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1403 int ret, pid_int = getpid();
1407 "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; "
1408 "gdb /proc/%d/exe %d'", pid_int, pid_int, pid_int) < 0)
1413 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1414 fn = dlsym(h, "_Insure_trap_error");
1417 ret = fn(a1, a2, a3, a4, a5, a6);
1427 /* Take a filename and filename length and return the most significant
1428 * filename suffix we can find. This ignores suffixes such as "~",
1429 * ".bak", ".orig", ".~1~", etc. */
1430 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1432 const char *suf, *s;
1436 /* One or more dots at the start aren't a suffix. */
1437 while (fn_len && *fn == '.') fn++, fn_len--;
1439 /* Ignore the ~ in a "foo~" filename. */
1440 if (fn_len > 1 && fn[fn_len-1] == '~')
1441 fn_len--, had_tilde = True;
1445 /* Assume we don't find an suffix. */
1449 /* Find the last significant suffix. */
1450 for (s = fn + fn_len; fn_len > 1; ) {
1451 while (*--s != '.' && s != fn) {}
1454 s_len = fn_len - (s - fn);
1457 if (strcmp(s+1, "bak") == 0
1458 || strcmp(s+1, "old") == 0)
1460 } else if (s_len == 5) {
1461 if (strcmp(s+1, "orig") == 0)
1463 } else if (s_len > 2 && had_tilde && s[1] == '~' && isDigit(s + 2))
1469 /* Determine if the suffix is all digits. */
1470 for (s++, s_len--; s_len > 0; s++, s_len--) {
1474 /* An all-digit suffix may not be that significant. */
1481 /* This is an implementation of the Levenshtein distance algorithm. It
1482 * was implemented to avoid needing a two-dimensional matrix (to save
1483 * memory). It was also tweaked to try to factor in the ASCII distance
1484 * between changed characters as a minor distance quantity. The normal
1485 * Levenshtein units of distance (each signifying a single change between
1486 * the two strings) are defined as a "UNIT". */
1488 #define UNIT (1 << 16)
1490 uint32 fuzzy_distance(const char *s1, unsigned len1, const char *s2, unsigned len2)
1492 uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1496 if (!len1 || !len2) {
1501 for (i1 = 0, cost = 0; i1 < len1; i1++)
1503 return (int32)len1 * UNIT + cost;
1506 for (i2 = 0; i2 < len2; i2++)
1507 a[i2] = (i2+1) * UNIT;
1509 for (i1 = 0; i1 < len1; i1++) {
1511 above = (i1+1) * UNIT;
1512 for (i2 = 0; i2 < len2; i2++) {
1514 if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1520 diag_inc = diag + cost;
1521 left_inc = left + UNIT + *((uchar*)s1+i1);
1522 above_inc = above + UNIT + *((uchar*)s2+i2);
1523 a[i2] = above = left < above
1524 ? (left_inc < diag_inc ? left_inc : diag_inc)
1525 : (above_inc < diag_inc ? above_inc : diag_inc);
1533 #define BB_SLOT_SIZE (16*1024) /* Desired size in bytes */
1534 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1535 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1542 struct bitbag *bitbag_create(int max_ndx)
1544 struct bitbag *bb = new(struct bitbag);
1545 bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1547 bb->bits = new_array0(uint32*, bb->slot_cnt);
1552 void bitbag_set_bit(struct bitbag *bb, int ndx)
1554 int slot = ndx / BB_PER_SLOT_BITS;
1555 ndx %= BB_PER_SLOT_BITS;
1557 if (!bb->bits[slot])
1558 bb->bits[slot] = new_array0(uint32, BB_PER_SLOT_INTS);
1560 bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1563 #if 0 /* not needed yet */
1564 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1566 int slot = ndx / BB_PER_SLOT_BITS;
1567 ndx %= BB_PER_SLOT_BITS;
1569 if (!bb->bits[slot])
1572 bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1575 int bitbag_check_bit(struct bitbag *bb, int ndx)
1577 int slot = ndx / BB_PER_SLOT_BITS;
1578 ndx %= BB_PER_SLOT_BITS;
1580 if (!bb->bits[slot])
1583 return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1587 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
1588 int bitbag_next_bit(struct bitbag *bb, int after)
1591 int i, ndx = after + 1;
1592 int slot = ndx / BB_PER_SLOT_BITS;
1593 ndx %= BB_PER_SLOT_BITS;
1595 mask = (1u << (ndx % 32)) - 1;
1596 for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1597 if (!bb->bits[slot])
1599 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1600 if (!(bits = bb->bits[slot][i] & ~mask))
1602 /* The xor magic figures out the lowest enabled bit in
1603 * bits, and the switch quickly computes log2(bit). */
1604 switch (bits ^ (bits & (bits-1))) {
1605 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1606 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
1607 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
1608 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
1609 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1610 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1611 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1612 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1613 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1615 return -1; /* impossible... */
1622 void flist_ndx_push(flist_ndx_list *lp, int ndx)
1624 struct flist_ndx_item *item;
1626 item = new(struct flist_ndx_item);
1630 lp->tail->next = item;
1636 int flist_ndx_pop(flist_ndx_list *lp)
1638 struct flist_ndx_item *next;
1644 ndx = lp->head->ndx;
1645 next = lp->head->next;
1654 /* Make sure there is room for one more item in the item list. If there
1655 * is not, expand the list as indicated by the value of "incr":
1656 * - if incr < 0 then increase the malloced size by -1 * incr
1657 * - if incr >= 0 then either make the malloced size equal to "incr"
1658 * or (if that's not large enough) double the malloced size
1659 * After the size check, the list's count is incremented by 1 and a pointer
1660 * to the "new" list item is returned.
1662 void *expand_item_list(item_list *lp, size_t item_size, const char *desc, int incr)
1664 /* First time through, 0 <= 0, so list is expanded. */
1665 if (lp->malloced <= lp->count) {
1669 expand_size = -incr; /* increase slowly */
1670 else if (lp->malloced < (size_t)incr)
1671 expand_size = incr - lp->malloced;
1672 else if (lp->malloced)
1673 expand_size = lp->malloced; /* double in size */
1676 if (SIZE_MAX/item_size - expand_size < lp->malloced)
1677 overflow_exit("expand_item_list");
1678 expand_size += lp->malloced;
1679 new_ptr = realloc_buf(lp->items, expand_size * item_size);
1680 if (DEBUG_GTE(FLIST, 3)) {
1681 rprintf(FINFO, "[%s] expand %s to %s bytes, did%s move\n",
1682 who_am_i(), desc, big_num(expand_size * item_size),
1683 new_ptr == lp->items ? " not" : "");
1686 lp->items = new_ptr;
1687 lp->malloced = expand_size;
1689 return (char*)lp->items + (lp->count++ * item_size);
1692 /* This zeroing of memory won't be optimized away by the compiler. */
1693 void force_memzero(void *buf, size_t len)
1695 volatile uchar *z = buf;