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_mtimes;
35 extern int preserve_xattrs;
36 extern int omit_link_times;
37 extern int preallocate_files;
38 extern char *module_dir;
39 extern unsigned int module_dirlen;
40 extern char *partial_dir;
41 extern filter_rule_list daemon_filter_list;
43 int sanitize_paths = 0;
45 char curr_dir[MAXPATHLEN];
46 unsigned int curr_dir_len;
47 int curr_dir_depth; /* This is only set for a sanitizing daemon. */
49 /* Set a fd into nonblocking mode. */
50 void set_nonblocking(int fd)
54 if ((val = fcntl(fd, F_GETFL)) == -1)
56 if (!(val & NONBLOCK_FLAG)) {
58 fcntl(fd, F_SETFL, val);
62 /* Set a fd into blocking mode. */
63 void set_blocking(int fd)
67 if ((val = fcntl(fd, F_GETFL)) == -1)
69 if (val & NONBLOCK_FLAG) {
70 val &= ~NONBLOCK_FLAG;
71 fcntl(fd, F_SETFL, val);
76 * Create a file descriptor pair - like pipe() but use socketpair if
77 * possible (because of blocking issues on pipes).
79 * Always set non-blocking.
81 int fd_pair(int fd[2])
85 #ifdef HAVE_SOCKETPAIR
86 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
92 set_nonblocking(fd[0]);
93 set_nonblocking(fd[1]);
99 void print_child_argv(const char *prefix, char **cmd)
102 rprintf(FCLIENT, "%s ", prefix);
103 for (; *cmd; cmd++) {
104 /* Look for characters that ought to be quoted. This
105 * is not a great quoting algorithm, but it's
106 * sufficient for a log message. */
107 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
108 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
110 ",.-_=+@/") != strlen(*cmd)) {
111 rprintf(FCLIENT, "\"%s\" ", *cmd);
113 rprintf(FCLIENT, "%s ", *cmd);
117 rprintf(FCLIENT, " (%d args)\n", cnt);
120 /* This returns 0 for success, 1 for a symlink if symlink time-setting
121 * is not possible, or -1 for any other error. */
122 int set_times(const char *fname, STRUCT_STAT *stp)
124 static int switch_step = 0;
126 if (DEBUG_GTE(TIME, 1)) {
128 "set modtime, atime of %s to (%ld) %s, (%ld) %s\n",
129 fname, (long)stp->st_mtime,
130 timestring(stp->st_mtime), (long)stp->st_atime, timestring(stp->st_atime));
133 switch (switch_step) {
134 #ifdef HAVE_SETATTRLIST
136 if (do_setattrlist_times(fname, stp) == 0)
143 #ifdef HAVE_UTIMENSAT
145 if (do_utimensat(fname, stp) == 0)
154 if (do_lutimes(fname, stp) == 0)
163 if (!omit_link_times) {
165 if (S_ISLNK(stp->st_mode))
171 if (do_utimes(fname, stp) == 0)
174 if (do_utime(fname, stp) == 0)
184 /* Create any necessary directories in fname. Any missing directories are
185 * created with default permissions. Returns < 0 on error, or the number
186 * of directories created. */
187 int make_path(char *fname, int flags)
192 if (flags & MKP_SKIP_SLASH) {
193 while (*fname == '/')
197 while (*fname == '.' && fname[1] == '/')
200 if (flags & MKP_DROP_NAME) {
201 end = strrchr(fname, '/');
202 if (!end || end == fname)
206 end = fname + strlen(fname);
208 /* Try to find an existing dir, starting from the deepest dir. */
212 if (do_stat(fname, &st) == 0) {
213 if (S_ISDIR(st.st_mode))
218 } else if (do_mkdir(fname, ACCESSPERMS) == 0) {
223 if (errno != ENOENT) {
225 if (errno != EEXIST || (do_stat(fname, &st) == 0 && !S_ISDIR(st.st_mode)))
231 /* We got a relative path that doesn't exist, so assume that '.'
232 * is there and just break out and create the whole thing. */
238 /* We reached the "/" dir, which we assume is there. */
248 /* Make all the dirs that we didn't find on the way here. */
255 if (ret < 0) /* Skip mkdir on error, but keep restoring the path. */
257 if (do_mkdir(fname, ACCESSPERMS) < 0)
263 if (flags & MKP_DROP_NAME)
270 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
273 * @retval len upon success
275 * @retval <0 write's (negative) error code
277 * Derived from GNU C's cccp.c.
279 int full_write(int desc, const char *ptr, size_t len)
285 int written = write(desc, ptr, len);
291 total_written += written;
295 return total_written;
299 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
302 * @retval >0 the actual number of bytes read
306 * @retval <0 for an error.
308 * Derived from GNU C's cccp.c. */
309 static int safe_read(int desc, char *ptr, size_t len)
317 n_chars = read(desc, ptr, len);
318 } while (n_chars < 0 && errno == EINTR);
323 /* Remove existing file @dest and reopen, creating a new file with @mode */
324 static int unlink_and_reopen(const char *dest, mode_t mode)
328 if (robust_unlink(dest) && errno != ENOENT) {
329 int save_errno = errno;
330 rsyserr(FERROR_XFER, errno, "unlink %s", full_fname(dest));
335 #ifdef SUPPORT_XATTRS
339 mode &= INITACCESSPERMS;
340 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0) {
341 int save_errno = errno;
342 rsyserr(FERROR_XFER, save_errno, "open %s", full_fname(dest));
349 /* Copy contents of file @source to file @dest with mode @mode.
351 * If @tmpfilefd is < 0, copy_file unlinks @dest and then opens a new
352 * file with name @dest.
354 * Otherwise, copy_file writes to and closes the provided file
357 * In either case, if --xattrs are being preserved, the dest file will
358 * have its xattrs set from the source file.
360 * This is used in conjunction with the --temp-dir, --backup, and
361 * --copy-dest options. */
362 int copy_file(const char *source, const char *dest, int tmpfilefd, mode_t mode)
366 int len; /* Number of bytes read into `buf'. */
367 OFF_T prealloc_len = 0, offset = 0;
369 if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
370 int save_errno = errno;
371 rsyserr(FERROR_XFER, errno, "open %s", full_fname(source));
376 if (tmpfilefd >= 0) {
379 ofd = unlink_and_reopen(dest, mode);
381 int save_errno = errno;
388 #ifdef SUPPORT_PREALLOCATION
389 if (preallocate_files) {
392 /* Try to preallocate enough space for file's eventual length. Can
393 * reduce fragmentation on filesystems like ext4, xfs, and NTFS. */
394 if (do_fstat(ifd, &srcst) < 0)
395 rsyserr(FWARNING, errno, "fstat %s", full_fname(source));
396 else if (srcst.st_size > 0) {
397 prealloc_len = do_fallocate(ofd, 0, srcst.st_size);
398 if (prealloc_len < 0)
399 rsyserr(FWARNING, errno, "do_fallocate %s", full_fname(dest));
404 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
405 if (full_write(ofd, buf, len) < 0) {
406 int save_errno = errno;
407 rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
417 int save_errno = errno;
418 rsyserr(FERROR_XFER, errno, "read %s", full_fname(source));
425 if (close(ifd) < 0) {
426 rsyserr(FWARNING, errno, "close failed on %s",
430 /* Source file might have shrunk since we fstatted it.
431 * Cut off any extra preallocated zeros from dest file. */
432 if (offset < prealloc_len) {
433 #ifdef HAVE_FTRUNCATE
434 /* If we fail to truncate, the dest file may be wrong, so we
435 * must trigger the "partial transfer" error. */
436 if (do_ftruncate(ofd, offset) < 0)
437 rsyserr(FERROR_XFER, errno, "ftruncate %s", full_fname(dest));
439 rprintf(FERROR_XFER, "no ftruncate for over-long pre-alloc: %s", full_fname(dest));
443 if (do_fsync && fsync(ofd) < 0) {
444 int save_errno = errno;
445 rsyserr(FERROR, errno, "fsync failed on %s", full_fname(dest));
451 if (close(ofd) < 0) {
452 int save_errno = errno;
453 rsyserr(FERROR_XFER, errno, "close failed on %s", full_fname(dest));
458 #ifdef SUPPORT_XATTRS
460 copy_xattrs(source, dest);
466 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
467 #define MAX_RENAMES_DIGITS 3
468 #define MAX_RENAMES 1000
471 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
472 * rename to <path>/.rsyncNNN instead.
474 * Note that successive rsync runs will shuffle the filenames around a
475 * bit as long as the file is still busy; this is because this function
476 * does not know if the unlink call is due to a new file coming in, or
477 * --delete trying to remove old .rsyncNNN files, hence it renames it
480 int robust_unlink(const char *fname)
483 return do_unlink(fname);
485 static int counter = 1;
487 char path[MAXPATHLEN];
489 rc = do_unlink(fname);
490 if (rc == 0 || errno != ETXTBSY)
493 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
494 pos = MAXPATHLEN - 1;
496 while (pos > 0 && path[pos-1] != '/')
498 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
500 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
505 /* start where the last one left off to reduce chance of clashes */
508 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
509 if (++counter >= MAX_RENAMES)
511 } while ((rc = access(path, 0)) == 0 && counter != start);
513 if (INFO_GTE(MISC, 1)) {
514 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
518 /* maybe we should return rename()'s exit status? Nah. */
519 if (do_rename(fname, path) != 0) {
527 /* Returns 0 on successful rename, 1 if we successfully copied the file
528 * across filesystems, -2 if copy_file() failed, and -1 on other errors.
529 * If partialptr is not NULL and we need to do a copy, copy the file into
530 * the active partial-dir instead of over the destination file. */
531 int robust_rename(const char *from, const char *to, const char *partialptr,
536 /* A resumed in-place partial-dir transfer might call us with from and
537 * to pointing to the same buf if the transfer failed yet again. */
542 if (do_rename(from, to) == 0)
548 if (robust_unlink(to) != 0) {
557 if (!handle_partial_dir(partialptr,PDIR_CREATE))
561 if (copy_file(from, to, -1, mode) != 0)
572 static pid_t all_pids[10];
575 /** Fork and record the pid of the child. **/
578 pid_t newpid = fork();
580 if (newpid != 0 && newpid != -1) {
581 all_pids[num_pids++] = newpid;
589 * @todo It would be kind of nice to make sure that they are actually
590 * all our children before we kill them, because their pids may have
591 * been recycled by some other process. Perhaps when we wait for a
592 * child, we should remove it from this array. Alternatively we could
593 * perhaps use process groups, but I think that would not work on
594 * ancient Unix versions that don't support them.
596 void kill_all(int sig)
600 for (i = 0; i < num_pids; i++) {
601 /* Let's just be a little careful where we
602 * point that gun, hey? See kill(2) for the
603 * magic caused by negative values. */
604 pid_t p = all_pids[i];
615 /** Lock a byte range in a open file */
616 int lock_range(int fd, int offset, int len)
620 lock.l_type = F_WRLCK;
621 lock.l_whence = SEEK_SET;
622 lock.l_start = offset;
626 return fcntl(fd,F_SETLK,&lock) == 0;
629 #define ENSURE_MEMSPACE(buf, type, sz, req) \
630 do { if ((req) > sz) buf = realloc_array(buf, type, sz = MAX(sz * 2, req)); } while(0)
632 static inline void call_glob_match(const char *name, int len, int from_glob,
633 char *arg, int abpos, int fbpos);
635 static struct glob_data {
636 char *arg_buf, *filt_buf, **argv;
637 int absize, fbsize, maxargs, argc;
640 static void glob_match(char *arg, int abpos, int fbpos)
645 while (*arg == '.' && arg[1] == '/') {
647 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, glob.absize);
648 memcpy(glob.filt_buf, glob.arg_buf, abpos + 1);
651 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + 3);
652 glob.arg_buf[abpos++] = *arg++;
653 glob.arg_buf[abpos++] = *arg++;
654 glob.arg_buf[abpos] = '\0';
656 if ((slash = strchr(arg, '/')) != NULL) {
661 if (strpbrk(arg, "*?[")) {
665 if (!(d = opendir(abpos ? glob.arg_buf : ".")))
667 while ((di = readdir(d)) != NULL) {
668 char *dname = d_name(di);
669 if (dname[0] == '.' && (dname[1] == '\0'
670 || (dname[1] == '.' && dname[2] == '\0')))
672 if (!wildmatch(arg, dname))
674 call_glob_match(dname, strlen(dname), 1,
675 slash ? arg + len + 1 : NULL,
680 call_glob_match(arg, len, 0,
681 slash ? arg + len + 1 : NULL,
688 static inline void call_glob_match(const char *name, int len, int from_glob,
689 char *arg, int abpos, int fbpos)
693 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + len + 2);
694 memcpy(glob.arg_buf + abpos, name, len);
696 glob.arg_buf[abpos] = '\0';
699 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, fbpos + len + 2);
700 memcpy(glob.filt_buf + fbpos, name, len);
702 glob.filt_buf[fbpos] = '\0';
703 use_buf = glob.filt_buf;
705 use_buf = glob.arg_buf;
707 if (from_glob || (arg && len)) {
711 if (do_stat(glob.arg_buf, &st) != 0)
713 is_dir = S_ISDIR(st.st_mode) != 0;
717 if (daemon_filter_list.head
718 && check_filter(&daemon_filter_list, FLOG, use_buf, is_dir) < 0)
723 glob.arg_buf[abpos++] = '/';
724 glob.arg_buf[abpos] = '\0';
726 glob.filt_buf[fbpos++] = '/';
727 glob.filt_buf[fbpos] = '\0';
729 glob_match(arg, abpos, fbpos);
731 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
732 glob.argv[glob.argc++] = strdup(glob.arg_buf);
736 /* This routine performs wild-card expansion of the pathname in "arg". Any
737 * daemon-excluded files/dirs will not be matched by the wildcards. Returns 0
738 * if a wild-card string is the only returned item (due to matching nothing). */
739 int glob_expand(const char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
748 memset(&glob, 0, sizeof glob);
753 s = sanitize_path(NULL, arg, "", 0, SP_KEEP_DOT_DIRS);
756 clean_fname(s, CFN_KEEP_DOT_DIRS | CFN_KEEP_TRAILING_SLASH | CFN_COLLAPSE_DOT_DOT_DIRS);
759 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, MAXPATHLEN);
760 *glob.arg_buf = '\0';
762 glob.argc = save_argc = *argc_p;
764 glob.maxargs = *maxargs_p;
766 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, 100);
768 glob_match(s, 0, -1);
770 /* The arg didn't match anything, so add the failed arg to the list. */
771 if (glob.argc == save_argc) {
772 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
773 glob.argv[glob.argc++] = s;
780 *maxargs_p = glob.maxargs;
787 /* This routine is only used in daemon mode. */
788 void glob_expand_module(char *base1, char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
792 int base_len = strlen(base);
797 if (strncmp(arg, base, base_len) == 0)
801 glob_expand(arg, argv_p, argc_p, maxargs_p);
807 if (asprintf(&base," %s/", base1) < 0)
808 out_of_memory("glob_expand_module");
811 for (s = arg; *s; s = p + base_len) {
812 if ((p = strstr(s, base)) != NULL)
813 *p = '\0'; /* split it at this point */
814 glob_expand(s, argv_p, argc_p, maxargs_p);
824 * Convert a string to lower case
826 void strlower(char *s)
836 * Split a string into tokens based (usually) on whitespace & commas. If the
837 * string starts with a comma (after skipping any leading whitespace), then
838 * splitting is done only on commas. No empty tokens are ever returned. */
839 char *conf_strtok(char *str)
841 static int commas_only = 0;
844 while (isSpace(str)) str++;
852 while (commas_only) {
853 char *end, *tok = strtok(str, ",");
856 /* Trim just leading and trailing whitespace. */
859 end = tok + strlen(tok);
860 while (end > tok && isSpace(end-1))
867 return strtok(str, " ,\t\r\n");
870 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
871 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
872 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
873 * string fits into destsize. */
874 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
876 size_t len = strlcpy(dest, p1, destsize);
877 if (len < destsize - 1) {
878 if (!len || dest[len-1] != '/')
880 if (len < destsize - 1)
881 len += strlcpy(dest + len, p2, destsize - len);
888 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
892 /* Join any number of strings together, putting them in "dest". The return
893 * value is the length of all the strings, regardless of whether the null-
894 * terminated whole fits in destsize. Your list of string pointers must end
895 * with a NULL to indicate the end of the list. */
896 size_t stringjoin(char *dest, size_t destsize, ...)
902 va_start(ap, destsize);
904 if (!(src = va_arg(ap, const char *)))
911 memcpy(dest, src, len);
922 int count_dir_elements(const char *p)
924 int cnt = 0, new_component = 1;
927 new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
928 else if (new_component) {
936 /* Turns multiple adjacent slashes into a single slash (possible exception:
937 * the preserving of two leading slashes at the start), drops all leading or
938 * interior "." elements unless CFN_KEEP_DOT_DIRS is flagged. Will also drop
939 * a trailing '.' after a '/' if CFN_DROP_TRAILING_DOT_DIR is flagged, removes
940 * a trailing slash (perhaps after removing the aforementioned dot) unless
941 * CFN_KEEP_TRAILING_SLASH is flagged, and will also collapse ".." elements
942 * (except at the start) if CFN_COLLAPSE_DOT_DOT_DIRS is flagged. If the
943 * resulting name would be empty, returns ".". */
944 int clean_fname(char *name, int flags)
946 char *limit = name - 1, *t = name, *f = name;
952 #define DOT_IS_DOT_DOT_DIR(bp) (bp[1] == '.' && (bp[2] == '/' || !bp[2]))
954 if ((anchored = *f == '/') != 0) {
957 /* If there are exactly 2 slashes at the start, preserve
958 * them. Would break daemon excludes unless the paths are
959 * really treated differently, so used this sparingly. */
960 if (*f == '/' && f[1] != '/')
963 } else if (flags & CFN_KEEP_DOT_DIRS && *f == '.' && f[1] == '/') {
966 } else if (flags & CFN_REFUSE_DOT_DOT_DIRS && *f == '.' && DOT_IS_DOT_DOT_DIR(f))
969 /* discard extra slashes */
975 /* discard interior "." dirs */
976 if (f[1] == '/' && !(flags & CFN_KEEP_DOT_DIRS)) {
980 if (f[1] == '\0' && flags & CFN_DROP_TRAILING_DOT_DIR)
982 /* collapse ".." dirs */
983 if (flags & (CFN_COLLAPSE_DOT_DOT_DIRS|CFN_REFUSE_DOT_DOT_DIRS) && DOT_IS_DOT_DOT_DIR(f)) {
985 if (flags & CFN_REFUSE_DOT_DOT_DIRS)
987 if (s == name && anchored) {
991 while (s > limit && *--s != '/') {}
992 if (s != t - 1 && (s < name || *s == '/')) {
1000 while (*f && (*t++ = *f++) != '/') {}
1003 if (t > name+anchored && t[-1] == '/' && !(flags & CFN_KEEP_TRAILING_SLASH))
1009 #undef DOT_IS_DOT_DOT_DIR
1014 /* Make path appear as if a chroot had occurred. This handles a leading
1015 * "/" (either removing it or expanding it) and any leading or embedded
1016 * ".." components that attempt to escape past the module's top dir.
1018 * If dest is NULL, a buffer is allocated to hold the result. It is legal
1019 * to call with the dest and the path (p) pointing to the same buffer, but
1020 * rootdir will be ignored to avoid expansion of the string.
1022 * The rootdir string contains a value to use in place of a leading slash.
1023 * Specify NULL to get the default of "module_dir".
1025 * The depth var is a count of how many '..'s to allow at the start of the
1028 * We also clean the path in a manner similar to clean_fname() but with a
1031 * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
1032 * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
1033 * ALWAYS collapses ".." elements (except for those at the start of the
1034 * string up to "depth" deep). If the resulting name would be empty,
1035 * change it into a ".". */
1036 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth, int flags)
1039 int rlen = 0, drop_dot_dirs = !relative_paths || !(flags & SP_KEEP_DOT_DIRS);
1042 int plen = strlen(p); /* the path len INCLUDING any separating slash */
1045 rootdir = module_dir;
1046 rlen = strlen(rootdir);
1051 dest = new_array(char, MAX(rlen + plen + 1, 2));
1052 else if (rlen + plen + 1 >= MAXPATHLEN)
1054 if (rlen) { /* only true if p previously started with a slash */
1055 memcpy(dest, rootdir, rlen);
1056 if (rlen > 1) /* a rootdir of len 1 is "/", so this avoids a 2nd slash */
1061 if (drop_dot_dirs) {
1062 while (*p == '.' && p[1] == '/')
1066 start = sanp = dest + rlen;
1067 /* This loop iterates once per filename component in p, pointing at
1068 * the start of the name (past any prior slash) for each iteration. */
1070 /* discard leading or extra slashes */
1075 if (drop_dot_dirs) {
1076 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
1077 /* skip "." component */
1082 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
1083 /* ".." component followed by slash or end */
1084 if (depth <= 0 || sanp != start) {
1086 if (sanp != start) {
1087 /* back up sanp one level */
1088 --sanp; /* now pointing at slash */
1089 while (sanp > start && sanp[-1] != '/')
1094 /* allow depth levels of .. at the beginning */
1096 /* move the virtual beginning to leave the .. alone */
1099 /* copy one component through next slash */
1100 while (*p && (*sanp++ = *p++) != '/') {}
1103 /* ended up with nothing, so put in "." component */
1111 /* Like chdir(), but it keeps track of the current directory (in the
1112 * global "curr_dir"), and ensures that the path size doesn't overflow.
1113 * Also cleans the path using the clean_fname() function. */
1114 int change_dir(const char *dir, int set_path_only)
1116 static int initialised, skipped_chdir;
1121 if (getcwd(curr_dir, sizeof curr_dir - 1) == NULL) {
1122 rsyserr(FERROR, errno, "getcwd()");
1123 exit_cleanup(RERR_FILESELECT);
1125 curr_dir_len = strlen(curr_dir);
1128 if (!dir) /* this call was probably just to initialize */
1132 if (len == 1 && *dir == '.' && (!skipped_chdir || set_path_only))
1136 if (len >= sizeof curr_dir) {
1137 errno = ENAMETOOLONG;
1140 if (!set_path_only && chdir(dir))
1142 skipped_chdir = set_path_only;
1143 memcpy(curr_dir, dir, len + 1);
1145 unsigned int save_dir_len = curr_dir_len;
1146 if (curr_dir_len + 1 + len >= sizeof curr_dir) {
1147 errno = ENAMETOOLONG;
1150 if (!(curr_dir_len && curr_dir[curr_dir_len-1] == '/'))
1151 curr_dir[curr_dir_len++] = '/';
1152 memcpy(curr_dir + curr_dir_len, dir, len + 1);
1154 if (!set_path_only && chdir(curr_dir)) {
1155 curr_dir_len = save_dir_len;
1156 curr_dir[curr_dir_len] = '\0';
1159 skipped_chdir = set_path_only;
1162 curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1163 if (sanitize_paths) {
1164 if (module_dirlen > curr_dir_len)
1165 module_dirlen = curr_dir_len;
1166 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
1169 if (DEBUG_GTE(CHDIR, 1) && !set_path_only)
1170 rprintf(FINFO, "[%s] change_dir(%s)\n", who_am_i(), curr_dir);
1175 /* This will make a relative path absolute and clean it up via clean_fname().
1176 * Returns the string, which might be newly allocated, or NULL on error. */
1177 char *normalize_path(char *path, BOOL force_newbuf, unsigned int *len_ptr)
1181 if (*path != '/') { /* Make path absolute. */
1182 int len = strlen(path);
1183 if (curr_dir_len + 1 + len >= sizeof curr_dir)
1185 curr_dir[curr_dir_len] = '/';
1186 memcpy(curr_dir + curr_dir_len + 1, path, len + 1);
1187 path = strdup(curr_dir);
1188 curr_dir[curr_dir_len] = '\0';
1189 } else if (force_newbuf)
1190 path = strdup(path);
1192 len = clean_fname(path, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1201 * Return a quoted string with the full pathname of the indicated filename.
1202 * The string " (in MODNAME)" may also be appended. The returned pointer
1203 * remains valid until the next time full_fname() is called.
1205 char *full_fname(const char *fn)
1207 static char *result = NULL;
1217 p1 = curr_dir + module_dirlen;
1218 for (p2 = p1; *p2 == '/'; p2++) {}
1222 if (module_id >= 0) {
1224 m2 = lp_name(module_id);
1229 if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) < 0)
1230 out_of_memory("full_fname");
1235 static char partial_fname[MAXPATHLEN];
1237 char *partial_dir_fname(const char *fname)
1239 char *t = partial_fname;
1240 int sz = sizeof partial_fname;
1243 if ((fn = strrchr(fname, '/')) != NULL) {
1245 if (*partial_dir != '/') {
1246 int len = fn - fname;
1247 strncpy(t, fname, len); /* safe */
1253 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
1255 if (daemon_filter_list.head) {
1256 t = strrchr(partial_fname, '/');
1258 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 1) < 0)
1261 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 0) < 0)
1265 return partial_fname;
1268 /* If no --partial-dir option was specified, we don't need to do anything
1269 * (the partial-dir is essentially '.'), so just return success. */
1270 int handle_partial_dir(const char *fname, int create)
1274 if (fname != partial_fname)
1276 if (!create && *partial_dir == '/')
1278 if (!(fn = strrchr(partial_fname, '/')))
1282 dir = partial_fname;
1285 int statret = do_lstat(dir, &st);
1286 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1287 if (do_unlink(dir) < 0) {
1293 if (statret < 0 && do_mkdir(dir, 0700) < 0) {
1304 /* Determine if a symlink points outside the current directory tree.
1305 * This is considered "unsafe" because e.g. when mirroring somebody
1306 * else's machine it might allow them to establish a symlink to
1307 * /etc/passwd, and then read it through a web server.
1309 * Returns 1 if unsafe, 0 if safe.
1311 * Null symlinks and absolute symlinks are always unsafe.
1313 * Basically here we are concerned with symlinks whose target contains
1314 * "..", because this might cause us to walk back up out of the
1315 * transferred directory. We are not allowed to go back up and
1318 * "dest" is the target of the symlink in question.
1320 * "src" is the top source directory currently applicable at the level
1321 * of the referenced symlink. This is usually the symlink's full path
1322 * (including its name), as referenced from the root of the transfer. */
1323 int unsafe_symlink(const char *dest, const char *src)
1325 const char *name, *slash;
1328 /* all absolute and null symlinks are unsafe */
1329 if (!dest || !*dest || *dest == '/')
1332 /* find out what our safety margin is */
1333 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1334 /* ".." segment starts the count over. "." segment is ignored. */
1335 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1340 while (slash[1] == '/') slash++; /* just in case src isn't clean */
1342 if (*name == '.' && name[1] == '.' && name[2] == '\0')
1345 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1346 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1347 if (name[1] == '.') {
1348 /* if at any point we go outside the current directory
1349 then stop - it is unsafe */
1355 while (slash[1] == '/') slash++;
1357 if (*name == '.' && name[1] == '.' && name[2] == '\0')
1363 /* Return the date and time as a string. Some callers tweak returned buf. */
1364 char *timestring(time_t t)
1367 static char buffers[4][20]; /* We support 4 simultaneous timestring results. */
1368 char *TimeBuf = buffers[ndx = (ndx + 1) % 4];
1369 struct tm *tm = localtime(&t);
1370 int len = snprintf(TimeBuf, sizeof buffers[0], "%4d/%02d/%02d %02d:%02d:%02d",
1371 (int)tm->tm_year + 1900, (int)tm->tm_mon + 1, (int)tm->tm_mday,
1372 (int)tm->tm_hour, (int)tm->tm_min, (int)tm->tm_sec);
1373 assert(len > 0); /* Silence gcc warning */
1378 /* Determine if two time_t values are equivalent (either exact, or in
1379 * the modification timestamp window established by --modify-window).
1380 * Returns 1 if the times the "same", or 0 if they are different. */
1381 int same_time(time_t f1_sec, unsigned long f1_nsec, time_t f2_sec, unsigned long f2_nsec)
1383 if (modify_window == 0)
1384 return f1_sec == f2_sec;
1385 if (modify_window < 0)
1386 return f1_sec == f2_sec && f1_nsec == f2_nsec;
1387 /* The nanoseconds do not figure into these checks -- time windows don't care about that. */
1388 if (f2_sec > f1_sec)
1389 return f2_sec - f1_sec <= modify_window;
1390 return f1_sec - f2_sec <= modify_window;
1397 This routine is a trick to immediately catch errors when debugging
1398 with insure. A xterm with a gdb is popped up when insure catches
1399 a error. It is Linux specific.
1401 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1404 int ret, pid_int = getpid();
1408 "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; "
1409 "gdb /proc/%d/exe %d'", pid_int, pid_int, pid_int) < 0)
1414 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1415 fn = dlsym(h, "_Insure_trap_error");
1418 ret = fn(a1, a2, a3, a4, a5, a6);
1428 /* Take a filename and filename length and return the most significant
1429 * filename suffix we can find. This ignores suffixes such as "~",
1430 * ".bak", ".orig", ".~1~", etc. */
1431 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1433 const char *suf, *s;
1437 /* One or more dots at the start aren't a suffix. */
1438 while (fn_len && *fn == '.') fn++, fn_len--;
1440 /* Ignore the ~ in a "foo~" filename. */
1441 if (fn_len > 1 && fn[fn_len-1] == '~')
1442 fn_len--, had_tilde = True;
1446 /* Assume we don't find an suffix. */
1450 /* Find the last significant suffix. */
1451 for (s = fn + fn_len; fn_len > 1; ) {
1452 while (*--s != '.' && s != fn) {}
1455 s_len = fn_len - (s - fn);
1458 if (strcmp(s+1, "bak") == 0
1459 || strcmp(s+1, "old") == 0)
1461 } else if (s_len == 5) {
1462 if (strcmp(s+1, "orig") == 0)
1464 } else if (s_len > 2 && had_tilde && s[1] == '~' && isDigit(s + 2))
1470 /* Determine if the suffix is all digits. */
1471 for (s++, s_len--; s_len > 0; s++, s_len--) {
1475 /* An all-digit suffix may not be that significant. */
1482 /* This is an implementation of the Levenshtein distance algorithm. It
1483 * was implemented to avoid needing a two-dimensional matrix (to save
1484 * memory). It was also tweaked to try to factor in the ASCII distance
1485 * between changed characters as a minor distance quantity. The normal
1486 * Levenshtein units of distance (each signifying a single change between
1487 * the two strings) are defined as a "UNIT". */
1489 #define UNIT (1 << 16)
1491 uint32 fuzzy_distance(const char *s1, unsigned len1, const char *s2, unsigned len2)
1493 uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1497 if (!len1 || !len2) {
1502 for (i1 = 0, cost = 0; i1 < len1; i1++)
1504 return (int32)len1 * UNIT + cost;
1507 for (i2 = 0; i2 < len2; i2++)
1508 a[i2] = (i2+1) * UNIT;
1510 for (i1 = 0; i1 < len1; i1++) {
1512 above = (i1+1) * UNIT;
1513 for (i2 = 0; i2 < len2; i2++) {
1515 if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1521 diag_inc = diag + cost;
1522 left_inc = left + UNIT + *((uchar*)s1+i1);
1523 above_inc = above + UNIT + *((uchar*)s2+i2);
1524 a[i2] = above = left < above
1525 ? (left_inc < diag_inc ? left_inc : diag_inc)
1526 : (above_inc < diag_inc ? above_inc : diag_inc);
1534 #define BB_SLOT_SIZE (16*1024) /* Desired size in bytes */
1535 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1536 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1543 struct bitbag *bitbag_create(int max_ndx)
1545 struct bitbag *bb = new(struct bitbag);
1546 bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1548 bb->bits = new_array0(uint32*, bb->slot_cnt);
1553 void bitbag_set_bit(struct bitbag *bb, int ndx)
1555 int slot = ndx / BB_PER_SLOT_BITS;
1556 ndx %= BB_PER_SLOT_BITS;
1558 if (!bb->bits[slot])
1559 bb->bits[slot] = new_array0(uint32, BB_PER_SLOT_INTS);
1561 bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1564 #if 0 /* not needed yet */
1565 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1567 int slot = ndx / BB_PER_SLOT_BITS;
1568 ndx %= BB_PER_SLOT_BITS;
1570 if (!bb->bits[slot])
1573 bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1576 int bitbag_check_bit(struct bitbag *bb, int ndx)
1578 int slot = ndx / BB_PER_SLOT_BITS;
1579 ndx %= BB_PER_SLOT_BITS;
1581 if (!bb->bits[slot])
1584 return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1588 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
1589 int bitbag_next_bit(struct bitbag *bb, int after)
1592 int i, ndx = after + 1;
1593 int slot = ndx / BB_PER_SLOT_BITS;
1594 ndx %= BB_PER_SLOT_BITS;
1596 mask = (1u << (ndx % 32)) - 1;
1597 for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1598 if (!bb->bits[slot])
1600 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1601 if (!(bits = bb->bits[slot][i] & ~mask))
1603 /* The xor magic figures out the lowest enabled bit in
1604 * bits, and the switch quickly computes log2(bit). */
1605 switch (bits ^ (bits & (bits-1))) {
1606 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1607 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
1608 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
1609 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
1610 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1611 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1612 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1613 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1614 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1616 return -1; /* impossible... */
1623 void flist_ndx_push(flist_ndx_list *lp, int ndx)
1625 struct flist_ndx_item *item;
1627 item = new(struct flist_ndx_item);
1631 lp->tail->next = item;
1637 int flist_ndx_pop(flist_ndx_list *lp)
1639 struct flist_ndx_item *next;
1645 ndx = lp->head->ndx;
1646 next = lp->head->next;
1655 /* Make sure there is room for one more item in the item list. If there
1656 * is not, expand the list as indicated by the value of "incr":
1657 * - if incr < 0 then increase the malloced size by -1 * incr
1658 * - if incr >= 0 then either make the malloced size equal to "incr"
1659 * or (if that's not large enough) double the malloced size
1660 * After the size check, the list's count is incremented by 1 and a pointer
1661 * to the "new" list item is returned.
1663 void *expand_item_list(item_list *lp, size_t item_size, const char *desc, int incr)
1665 /* First time through, 0 <= 0, so list is expanded. */
1666 if (lp->malloced <= lp->count) {
1670 expand_size = -incr; /* increase slowly */
1671 else if (lp->malloced < (size_t)incr)
1672 expand_size = incr - lp->malloced;
1673 else if (lp->malloced)
1674 expand_size = lp->malloced; /* double in size */
1677 if (SIZE_MAX/item_size - expand_size < lp->malloced)
1678 overflow_exit("expand_item_list");
1679 expand_size += lp->malloced;
1680 new_ptr = realloc_buf(lp->items, expand_size * item_size);
1681 if (DEBUG_GTE(FLIST, 3)) {
1682 rprintf(FINFO, "[%s] expand %s to %s bytes, did%s move\n",
1683 who_am_i(), desc, big_num(expand_size * item_size),
1684 new_ptr == lp->items ? " not" : "");
1687 lp->items = new_ptr;
1688 lp->malloced = expand_size;
1690 return (char*)lp->items + (lp->count++ * item_size);
1693 /* This zeroing of memory won't be optimized away by the compiler. */
1694 void force_memzero(void *buf, size_t len)
1696 volatile uchar *z = buf;