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-2009 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.
28 extern int modify_window;
29 extern int relative_paths;
30 extern int preserve_times;
31 extern int human_readable;
32 extern int preserve_xattrs;
33 extern char *module_dir;
34 extern unsigned int module_dirlen;
35 extern mode_t orig_umask;
36 extern char *partial_dir;
37 extern struct filter_list_struct daemon_filter_list;
39 int sanitize_paths = 0;
41 char curr_dir[MAXPATHLEN];
42 unsigned int curr_dir_len;
43 int curr_dir_depth; /* This is only set for a sanitizing daemon. */
45 /* Set a fd into nonblocking mode. */
46 void set_nonblocking(int fd)
50 if ((val = fcntl(fd, F_GETFL)) == -1)
52 if (!(val & NONBLOCK_FLAG)) {
54 fcntl(fd, F_SETFL, val);
58 /* Set a fd into blocking mode. */
59 void set_blocking(int fd)
63 if ((val = fcntl(fd, F_GETFL)) == -1)
65 if (val & NONBLOCK_FLAG) {
66 val &= ~NONBLOCK_FLAG;
67 fcntl(fd, F_SETFL, val);
72 * Create a file descriptor pair - like pipe() but use socketpair if
73 * possible (because of blocking issues on pipes).
75 * Always set non-blocking.
77 int fd_pair(int fd[2])
81 #ifdef HAVE_SOCKETPAIR
82 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
88 set_nonblocking(fd[0]);
89 set_nonblocking(fd[1]);
95 void print_child_argv(const char *prefix, char **cmd)
97 rprintf(FCLIENT, "%s ", prefix);
99 /* Look for characters that ought to be quoted. This
100 * is not a great quoting algorithm, but it's
101 * sufficient for a log message. */
102 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
103 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
105 ",.-_=+@/") != strlen(*cmd)) {
106 rprintf(FCLIENT, "\"%s\" ", *cmd);
108 rprintf(FCLIENT, "%s ", *cmd);
111 rprintf(FCLIENT, "\n");
114 NORETURN void out_of_memory(const char *str)
116 rprintf(FERROR, "ERROR: out of memory in %s [%s]\n", str, who_am_i());
117 exit_cleanup(RERR_MALLOC);
120 NORETURN void overflow_exit(const char *str)
122 rprintf(FERROR, "ERROR: buffer overflow in %s [%s]\n", str, who_am_i());
123 exit_cleanup(RERR_MALLOC);
126 /* This returns 0 for success, 1 for a symlink if symlink time-setting
127 * is not possible, or -1 for any other error. */
128 int set_modtime(const char *fname, time_t modtime, mode_t mode)
130 static int switch_step = 0;
133 rprintf(FINFO, "set modtime of %s to (%ld) %s",
134 fname, (long)modtime,
135 asctime(localtime(&modtime)));
138 switch (switch_step) {
139 #ifdef HAVE_UTIMENSAT
141 if (do_utimensat(fname, modtime, 0) == 0)
151 if (do_lutimes(fname, modtime, 0) == 0)
161 if (preserve_times & PRESERVE_LINK_TIMES) {
162 preserve_times &= ~PRESERVE_LINK_TIMES;
170 if (do_utimes(fname, modtime, 0) == 0)
173 if (do_utime(fname, modtime, 0) == 0)
183 /* This creates a new directory with default permissions. Since there
184 * might be some directory-default permissions affecting this, we can't
185 * force the permissions directly using the original umask and mkdir(). */
186 int mkdir_defmode(char *fname)
191 ret = do_mkdir(fname, ACCESSPERMS);
197 /* Create any necessary directories in fname. Any missing directories are
198 * created with default permissions. */
199 int create_directory_path(char *fname)
204 while (*fname == '/')
206 while (strncmp(fname, "./", 2) == 0)
211 while ((p = strchr(p,'/')) != NULL) {
213 if (do_mkdir(fname, ACCESSPERMS) < 0 && errno != EEXIST)
223 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
226 * @retval len upon success
228 * @retval <0 write's (negative) error code
230 * Derived from GNU C's cccp.c.
232 int full_write(int desc, const char *ptr, size_t len)
238 int written = write(desc, ptr, len);
244 total_written += written;
248 return total_written;
252 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
255 * @retval >0 the actual number of bytes read
259 * @retval <0 for an error.
261 * Derived from GNU C's cccp.c. */
262 static int safe_read(int desc, char *ptr, size_t len)
270 n_chars = read(desc, ptr, len);
271 } while (n_chars < 0 && errno == EINTR);
276 /* Copy a file. If ofd < 0, copy_file unlinks and opens the "dest" file.
277 * Otherwise, it just writes to and closes the provided file descriptor.
278 * In either case, if --xattrs are being preserved, the dest file will
279 * have its xattrs set from the source file.
281 * This is used in conjunction with the --temp-dir, --backup, and
282 * --copy-dest options. */
283 int copy_file(const char *source, const char *dest, int ofd,
284 mode_t mode, int create_bak_dir)
288 int len; /* Number of bytes read into `buf'. */
290 if ((ifd = do_open(source, O_RDONLY, 0)) < 0) {
291 int save_errno = errno;
292 rsyserr(FERROR_XFER, errno, "open %s", full_fname(source));
298 if (robust_unlink(dest) && errno != ENOENT) {
299 int save_errno = errno;
300 rsyserr(FERROR_XFER, errno, "unlink %s", full_fname(dest));
305 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0) {
306 int save_errno = errno ? errno : EINVAL; /* 0 paranoia */
307 if (create_bak_dir && errno == ENOENT && make_bak_dir(dest) == 0) {
308 if ((ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode)) < 0)
309 save_errno = errno ? errno : save_errno;
314 rsyserr(FERROR_XFER, save_errno, "open %s", full_fname(dest));
322 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
323 if (full_write(ofd, buf, len) < 0) {
324 int save_errno = errno;
325 rsyserr(FERROR_XFER, errno, "write %s", full_fname(dest));
334 int save_errno = errno;
335 rsyserr(FERROR_XFER, errno, "read %s", full_fname(source));
342 if (close(ifd) < 0) {
343 rsyserr(FWARNING, errno, "close failed on %s",
347 if (close(ofd) < 0) {
348 int save_errno = errno;
349 rsyserr(FERROR_XFER, errno, "close failed on %s",
355 #ifdef SUPPORT_XATTRS
357 copy_xattrs(source, dest);
363 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
364 #define MAX_RENAMES_DIGITS 3
365 #define MAX_RENAMES 1000
368 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
369 * rename to <path>/.rsyncNNN instead.
371 * Note that successive rsync runs will shuffle the filenames around a
372 * bit as long as the file is still busy; this is because this function
373 * does not know if the unlink call is due to a new file coming in, or
374 * --delete trying to remove old .rsyncNNN files, hence it renames it
377 int robust_unlink(const char *fname)
380 return do_unlink(fname);
382 static int counter = 1;
384 char path[MAXPATHLEN];
386 rc = do_unlink(fname);
387 if (rc == 0 || errno != ETXTBSY)
390 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
391 pos = MAXPATHLEN - 1;
393 while (pos > 0 && path[pos-1] != '/')
395 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
397 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
402 /* start where the last one left off to reduce chance of clashes */
405 snprintf(&path[pos], MAX_RENAMES_DIGITS+1, "%03d", counter);
406 if (++counter >= MAX_RENAMES)
408 } while ((rc = access(path, 0)) == 0 && counter != start);
411 rprintf(FWARNING, "renaming %s to %s because of text busy\n",
415 /* maybe we should return rename()'s exit status? Nah. */
416 if (do_rename(fname, path) != 0) {
424 /* Returns 0 on successful rename, 1 if we successfully copied the file
425 * across filesystems, -2 if copy_file() failed, and -1 on other errors.
426 * If partialptr is not NULL and we need to do a copy, copy the file into
427 * the active partial-dir instead of over the destination file. */
428 int robust_rename(const char *from, const char *to, const char *partialptr,
434 if (do_rename(from, to) == 0)
440 if (robust_unlink(to) != 0) {
449 if (!handle_partial_dir(partialptr,PDIR_CREATE))
453 if (copy_file(from, to, -1, mode, 0) != 0)
464 static pid_t all_pids[10];
467 /** Fork and record the pid of the child. **/
470 pid_t newpid = fork();
472 if (newpid != 0 && newpid != -1) {
473 all_pids[num_pids++] = newpid;
481 * @todo It would be kind of nice to make sure that they are actually
482 * all our children before we kill them, because their pids may have
483 * been recycled by some other process. Perhaps when we wait for a
484 * child, we should remove it from this array. Alternatively we could
485 * perhaps use process groups, but I think that would not work on
486 * ancient Unix versions that don't support them.
488 void kill_all(int sig)
492 for (i = 0; i < num_pids; i++) {
493 /* Let's just be a little careful where we
494 * point that gun, hey? See kill(2) for the
495 * magic caused by negative values. */
496 pid_t p = all_pids[i];
507 /** Turn a user name into a uid */
508 int name_to_uid(const char *name, uid_t *uid_p)
513 if (!(pass = getpwnam(name)))
515 *uid_p = pass->pw_uid;
519 /** Turn a group name into a gid */
520 int name_to_gid(const char *name, gid_t *gid_p)
525 if (!(grp = getgrnam(name)))
527 *gid_p = grp->gr_gid;
531 /** Lock a byte range in a open file */
532 int lock_range(int fd, int offset, int len)
536 lock.l_type = F_WRLCK;
537 lock.l_whence = SEEK_SET;
538 lock.l_start = offset;
542 return fcntl(fd,F_SETLK,&lock) == 0;
545 #define ENSURE_MEMSPACE(buf, type, sz, req) \
546 if ((req) > sz && !(buf = realloc_array(buf, type, sz = MAX(sz * 2, req)))) \
547 out_of_memory("glob_expand")
549 static inline void call_glob_match(const char *name, int len, int from_glob,
550 char *arg, int abpos, int fbpos);
552 static struct glob_data {
553 char *arg_buf, *filt_buf, **argv;
554 int absize, fbsize, maxargs, argc;
557 static void glob_match(char *arg, int abpos, int fbpos)
562 while (*arg == '.' && arg[1] == '/') {
564 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, glob.absize);
565 memcpy(glob.filt_buf, glob.arg_buf, abpos + 1);
568 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + 3);
569 glob.arg_buf[abpos++] = *arg++;
570 glob.arg_buf[abpos++] = *arg++;
571 glob.arg_buf[abpos] = '\0';
573 if ((slash = strchr(arg, '/')) != NULL) {
578 if (strpbrk(arg, "*?[")) {
582 if (!(d = opendir(abpos ? glob.arg_buf : ".")))
584 while ((di = readdir(d)) != NULL) {
585 char *dname = d_name(di);
586 if (dname[0] == '.' && (dname[1] == '\0'
587 || (dname[1] == '.' && dname[2] == '\0')))
589 if (!wildmatch(arg, dname))
591 call_glob_match(dname, strlen(dname), 1,
592 slash ? arg + len + 1 : NULL,
597 call_glob_match(arg, len, 0,
598 slash ? arg + len + 1 : NULL,
605 static inline void call_glob_match(const char *name, int len, int from_glob,
606 char *arg, int abpos, int fbpos)
610 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, abpos + len + 2);
611 memcpy(glob.arg_buf + abpos, name, len);
613 glob.arg_buf[abpos] = '\0';
616 ENSURE_MEMSPACE(glob.filt_buf, char, glob.fbsize, fbpos + len + 2);
617 memcpy(glob.filt_buf + fbpos, name, len);
619 glob.filt_buf[fbpos] = '\0';
620 use_buf = glob.filt_buf;
622 use_buf = glob.arg_buf;
624 if (from_glob || (arg && len)) {
628 if (do_stat(glob.arg_buf, &st) != 0)
630 is_dir = S_ISDIR(st.st_mode) != 0;
634 if (daemon_filter_list.head
635 && check_filter(&daemon_filter_list, FLOG, use_buf, is_dir) < 0)
640 glob.arg_buf[abpos++] = '/';
641 glob.arg_buf[abpos] = '\0';
643 glob.filt_buf[fbpos++] = '/';
644 glob.filt_buf[fbpos] = '\0';
646 glob_match(arg, abpos, fbpos);
648 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
649 if (!(glob.argv[glob.argc++] = strdup(glob.arg_buf)))
650 out_of_memory("glob_match");
654 /* This routine performs wild-card expansion of the pathname in "arg". Any
655 * daemon-excluded files/dirs will not be matched by the wildcards. Returns 0
656 * if a wild-card string is the only returned item (due to matching nothing). */
657 int glob_expand(const char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
666 memset(&glob, 0, sizeof glob);
671 s = sanitize_path(NULL, arg, "", 0, SP_KEEP_DOT_DIRS);
675 out_of_memory("glob_expand");
676 clean_fname(s, CFN_KEEP_DOT_DIRS
677 | CFN_KEEP_TRAILING_SLASH
678 | CFN_COLLAPSE_DOT_DOT_DIRS);
681 ENSURE_MEMSPACE(glob.arg_buf, char, glob.absize, MAXPATHLEN);
682 *glob.arg_buf = '\0';
684 glob.argc = save_argc = *argc_p;
686 glob.maxargs = *maxargs_p;
688 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, 100);
690 glob_match(s, 0, -1);
692 /* The arg didn't match anything, so add the failed arg to the list. */
693 if (glob.argc == save_argc) {
694 ENSURE_MEMSPACE(glob.argv, char *, glob.maxargs, glob.argc + 1);
695 glob.argv[glob.argc++] = s;
702 *maxargs_p = glob.maxargs;
709 /* This routine is only used in daemon mode. */
710 void glob_expand_module(char *base1, char *arg, char ***argv_p, int *argc_p, int *maxargs_p)
714 int base_len = strlen(base);
719 if (strncmp(arg, base, base_len) == 0)
722 if (!(arg = strdup(arg)))
723 out_of_memory("glob_expand_module");
725 if (asprintf(&base," %s/", base1) <= 0)
726 out_of_memory("glob_expand_module");
729 for (s = arg; *s; s = p + base_len) {
730 if ((p = strstr(s, base)) != NULL)
731 *p = '\0'; /* split it at this point */
732 glob_expand(s, argv_p, argc_p, maxargs_p);
742 * Convert a string to lower case
744 void strlower(char *s)
753 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
754 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
755 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
756 * string fits into destsize. */
757 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
759 size_t len = strlcpy(dest, p1, destsize);
760 if (len < destsize - 1) {
761 if (!len || dest[len-1] != '/')
763 if (len < destsize - 1)
764 len += strlcpy(dest + len, p2, destsize - len);
771 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
775 /* Join any number of strings together, putting them in "dest". The return
776 * value is the length of all the strings, regardless of whether the null-
777 * terminated whole fits in destsize. Your list of string pointers must end
778 * with a NULL to indicate the end of the list. */
779 size_t stringjoin(char *dest, size_t destsize, ...)
785 va_start(ap, destsize);
787 if (!(src = va_arg(ap, const char *)))
794 memcpy(dest, src, len);
805 int count_dir_elements(const char *p)
807 int cnt = 0, new_component = 1;
810 new_component = (*p != '.' || (p[1] != '/' && p[1] != '\0'));
811 else if (new_component) {
819 /* Turns multiple adjacent slashes into a single slash (possible exception:
820 * the preserving of two leading slashes at the start), drops all leading or
821 * interior "." elements unless CFN_KEEP_DOT_DIRS is flagged. Will also drop
822 * a trailing '.' after a '/' if CFN_DROP_TRAILING_DOT_DIR is flagged, removes
823 * a trailing slash (perhaps after removing the aforementioned dot) unless
824 * CFN_KEEP_TRAILING_SLASH is flagged, and will also collapse ".." elements
825 * (except at the start) if CFN_COLLAPSE_DOT_DOT_DIRS is flagged. If the
826 * resulting name would be empty, returns ".". */
827 unsigned int clean_fname(char *name, int flags)
829 char *limit = name - 1, *t = name, *f = name;
835 if ((anchored = *f == '/') != 0) {
838 /* If there are exactly 2 slashes at the start, preserve
839 * them. Would break daemon excludes unless the paths are
840 * really treated differently, so used this sparingly. */
841 if (*f == '/' && f[1] != '/')
844 } else if (flags & CFN_KEEP_DOT_DIRS && *f == '.' && f[1] == '/') {
849 /* discard extra slashes */
855 /* discard interior "." dirs */
856 if (f[1] == '/' && !(flags & CFN_KEEP_DOT_DIRS)) {
860 if (f[1] == '\0' && flags & CFN_DROP_TRAILING_DOT_DIR)
862 /* collapse ".." dirs */
863 if (flags & CFN_COLLAPSE_DOT_DOT_DIRS
864 && f[1] == '.' && (f[2] == '/' || !f[2])) {
866 if (s == name && anchored) {
870 while (s > limit && *--s != '/') {}
871 if (s != t - 1 && (s < name || *s == '/')) {
879 while (*f && (*t++ = *f++) != '/') {}
882 if (t > name+anchored && t[-1] == '/' && !(flags & CFN_KEEP_TRAILING_SLASH))
891 /* Make path appear as if a chroot had occurred. This handles a leading
892 * "/" (either removing it or expanding it) and any leading or embedded
893 * ".." components that attempt to escape past the module's top dir.
895 * If dest is NULL, a buffer is allocated to hold the result. It is legal
896 * to call with the dest and the path (p) pointing to the same buffer, but
897 * rootdir will be ignored to avoid expansion of the string.
899 * The rootdir string contains a value to use in place of a leading slash.
900 * Specify NULL to get the default of "module_dir".
902 * The depth var is a count of how many '..'s to allow at the start of the
905 * We also clean the path in a manner similar to clean_fname() but with a
908 * Turns multiple adjacent slashes into a single slash, gets rid of "." dir
909 * elements (INCLUDING a trailing dot dir), PRESERVES a trailing slash, and
910 * ALWAYS collapses ".." elements (except for those at the start of the
911 * string up to "depth" deep). If the resulting name would be empty,
912 * change it into a ".". */
913 char *sanitize_path(char *dest, const char *p, const char *rootdir, int depth,
917 int rlen = 0, drop_dot_dirs = !relative_paths || !(flags & SP_KEEP_DOT_DIRS);
920 int plen = strlen(p);
923 rootdir = module_dir;
924 rlen = strlen(rootdir);
929 if (rlen + plen + 1 >= MAXPATHLEN)
931 } else if (!(dest = new_array(char, rlen + plen + 1)))
932 out_of_memory("sanitize_path");
934 memcpy(dest, rootdir, rlen);
941 while (*p == '.' && p[1] == '/')
945 start = sanp = dest + rlen;
946 /* This loop iterates once per filename component in p, pointing at
947 * the start of the name (past any prior slash) for each iteration. */
949 /* discard leading or extra slashes */
955 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
956 /* skip "." component */
961 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
962 /* ".." component followed by slash or end */
963 if (depth <= 0 || sanp != start) {
966 /* back up sanp one level */
967 --sanp; /* now pointing at slash */
968 while (sanp > start && sanp[-1] != '/')
973 /* allow depth levels of .. at the beginning */
975 /* move the virtual beginning to leave the .. alone */
978 /* copy one component through next slash */
979 while (*p && (*sanp++ = *p++) != '/') {}
982 /* ended up with nothing, so put in "." component */
990 /* Like chdir(), but it keeps track of the current directory (in the
991 * global "curr_dir"), and ensures that the path size doesn't overflow.
992 * Also cleans the path using the clean_fname() function. */
993 int change_dir(const char *dir, int set_path_only)
995 static int initialised;
1000 if (getcwd(curr_dir, sizeof curr_dir - 1) == NULL) {
1001 rsyserr(FERROR, errno, "getcwd()");
1002 exit_cleanup(RERR_FILESELECT);
1004 curr_dir_len = strlen(curr_dir);
1007 if (!dir) /* this call was probably just to initialize */
1011 if (len == 1 && *dir == '.')
1015 if (len >= sizeof curr_dir) {
1016 errno = ENAMETOOLONG;
1019 if (!set_path_only && chdir(dir))
1021 memcpy(curr_dir, dir, len + 1);
1023 if (curr_dir_len + 1 + len >= sizeof curr_dir) {
1024 errno = ENAMETOOLONG;
1027 if (!(curr_dir_len && curr_dir[curr_dir_len-1] == '/'))
1028 curr_dir[curr_dir_len++] = '/';
1029 memcpy(curr_dir + curr_dir_len, dir, len + 1);
1031 if (!set_path_only && chdir(curr_dir)) {
1032 curr_dir[curr_dir_len] = '\0';
1037 curr_dir_len = clean_fname(curr_dir, CFN_COLLAPSE_DOT_DOT_DIRS);
1038 if (sanitize_paths) {
1039 if (module_dirlen > curr_dir_len)
1040 module_dirlen = curr_dir_len;
1041 curr_dir_depth = count_dir_elements(curr_dir + module_dirlen);
1044 if (verbose >= 5 && !set_path_only)
1045 rprintf(FINFO, "[%s] change_dir(%s)\n", who_am_i(), curr_dir);
1050 /* This will make a relative path absolute and clean it up via clean_fname().
1051 * Returns the string, which might be newly allocated, or NULL on error. */
1052 char *normalize_path(char *path, BOOL force_newbuf, unsigned int *len_ptr)
1056 if (*path != '/') { /* Make path absolute. */
1057 int len = strlen(path);
1058 if (curr_dir_len + 1 + len >= sizeof curr_dir)
1060 curr_dir[curr_dir_len] = '/';
1061 memcpy(curr_dir + curr_dir_len + 1, path, len + 1);
1062 if (!(path = strdup(curr_dir)))
1063 out_of_memory("normalize_path");
1064 curr_dir[curr_dir_len] = '\0';
1065 } else if (force_newbuf) {
1066 if (!(path = strdup(path)))
1067 out_of_memory("normalize_path");
1070 len = clean_fname(path, CFN_COLLAPSE_DOT_DOT_DIRS | CFN_DROP_TRAILING_DOT_DIR);
1079 * Return a quoted string with the full pathname of the indicated filename.
1080 * The string " (in MODNAME)" may also be appended. The returned pointer
1081 * remains valid until the next time full_fname() is called.
1083 char *full_fname(const char *fn)
1085 static char *result = NULL;
1095 p1 = curr_dir + module_dirlen;
1096 for (p2 = p1; *p2 == '/'; p2++) {}
1100 if (module_id >= 0) {
1102 m2 = lp_name(module_id);
1107 if (asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3) <= 0)
1108 out_of_memory("full_fname");
1113 static char partial_fname[MAXPATHLEN];
1115 char *partial_dir_fname(const char *fname)
1117 char *t = partial_fname;
1118 int sz = sizeof partial_fname;
1121 if ((fn = strrchr(fname, '/')) != NULL) {
1123 if (*partial_dir != '/') {
1124 int len = fn - fname;
1125 strncpy(t, fname, len); /* safe */
1131 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
1133 if (daemon_filter_list.head) {
1134 t = strrchr(partial_fname, '/');
1136 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 1) < 0)
1139 if (check_filter(&daemon_filter_list, FLOG, partial_fname, 0) < 0)
1143 return partial_fname;
1146 /* If no --partial-dir option was specified, we don't need to do anything
1147 * (the partial-dir is essentially '.'), so just return success. */
1148 int handle_partial_dir(const char *fname, int create)
1152 if (fname != partial_fname)
1154 if (!create && *partial_dir == '/')
1156 if (!(fn = strrchr(partial_fname, '/')))
1160 dir = partial_fname;
1163 int statret = do_lstat(dir, &st);
1164 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1165 if (do_unlink(dir) < 0) {
1171 if (statret < 0 && do_mkdir(dir, 0700) < 0) {
1182 /* Determine if a symlink points outside the current directory tree.
1183 * This is considered "unsafe" because e.g. when mirroring somebody
1184 * else's machine it might allow them to establish a symlink to
1185 * /etc/passwd, and then read it through a web server.
1187 * Returns 1 if unsafe, 0 if safe.
1189 * Null symlinks and absolute symlinks are always unsafe.
1191 * Basically here we are concerned with symlinks whose target contains
1192 * "..", because this might cause us to walk back up out of the
1193 * transferred directory. We are not allowed to go back up and
1196 * "dest" is the target of the symlink in question.
1198 * "src" is the top source directory currently applicable at the level
1199 * of the referenced symlink. This is usually the symlink's full path
1200 * (including its name), as referenced from the root of the transfer. */
1201 int unsafe_symlink(const char *dest, const char *src)
1203 const char *name, *slash;
1206 /* all absolute and null symlinks are unsafe */
1207 if (!dest || !*dest || *dest == '/')
1210 /* find out what our safety margin is */
1211 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1212 /* ".." segment starts the count over. "." segment is ignored. */
1213 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1218 while (slash[1] == '/') slash++; /* just in case src isn't clean */
1220 if (*name == '.' && name[1] == '.' && name[2] == '\0')
1223 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1224 if (*name == '.' && (name[1] == '/' || (name[1] == '.' && name[2] == '/'))) {
1225 if (name[1] == '.') {
1226 /* if at any point we go outside the current directory
1227 then stop - it is unsafe */
1233 while (slash[1] == '/') slash++;
1235 if (*name == '.' && name[1] == '.' && name[2] == '\0')
1241 #define HUMANIFY(mult) \
1243 if (num >= mult || num <= -mult) { \
1244 double dnum = (double)num / mult; \
1250 else if ((dnum /= mult) < mult) \
1258 snprintf(bufs[n], sizeof bufs[0], "%.2f%c", dnum, units); \
1263 /* Return the int64 number as a string. If the --human-readable option was
1264 * specified, we may output the number in K, M, or G units. We can return
1265 * up to 4 buffers at a time. */
1266 char *human_num(int64 num)
1268 static char bufs[4][128]; /* more than enough room */
1269 static unsigned int n;
1273 n = (n + 1) % (sizeof bufs / sizeof bufs[0]);
1275 if (human_readable) {
1276 if (human_readable == 1)
1282 s = bufs[n] + sizeof bufs[0] - 1;
1288 /* A maximum-size negated number can't fit as a positive,
1289 * so do one digit in negated form to start us off. */
1290 *--s = (char)(-(num % 10)) + '0';
1297 *--s = (char)(num % 10) + '0';
1307 /* Return the double number as a string. If the --human-readable option was
1308 * specified, we may output the number in K, M, or G units. We use a buffer
1309 * from human_num() to return our result. */
1310 char *human_dnum(double dnum, int decimal_digits)
1312 char *buf = human_num(dnum);
1313 int len = strlen(buf);
1314 if (isDigit(buf + len - 1)) {
1315 /* There's extra room in buf prior to the start of the num. */
1316 buf -= decimal_digits + 2;
1317 snprintf(buf, len + decimal_digits + 3, "%.*f", decimal_digits, dnum);
1322 /* Return the date and time as a string. Some callers tweak returned buf. */
1323 char *timestring(time_t t)
1325 static char TimeBuf[200];
1326 struct tm *tm = localtime(&t);
1329 #ifdef HAVE_STRFTIME
1330 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1332 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1335 if ((p = strchr(TimeBuf, '\n')) != NULL)
1342 * Sleep for a specified number of milliseconds.
1344 * Always returns TRUE. (In the future it might return FALSE if
1350 struct timeval tval, t1, t2;
1352 gettimeofday(&t1, NULL);
1355 tval.tv_sec = (t-tdiff)/1000;
1356 tval.tv_usec = 1000*((t-tdiff)%1000);
1359 select(0,NULL,NULL, NULL, &tval);
1361 gettimeofday(&t2, NULL);
1362 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
1363 (t2.tv_usec - t1.tv_usec)/1000;
1369 /* Determine if two time_t values are equivalent (either exact, or in
1370 * the modification timestamp window established by --modify-window).
1372 * @retval 0 if the times should be treated as the same
1374 * @retval +1 if the first is later
1376 * @retval -1 if the 2nd is later
1378 int cmp_time(time_t file1, time_t file2)
1380 if (file2 > file1) {
1381 if (file2 - file1 <= modify_window)
1385 if (file1 - file2 <= modify_window)
1395 This routine is a trick to immediately catch errors when debugging
1396 with insure. A xterm with a gdb is popped up when insure catches
1397 a error. It is Linux specific.
1399 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1405 asprintf(&cmd, "/usr/X11R6/bin/xterm -display :0 -T Panic -n Panic -e /bin/sh -c 'cat /tmp/ierrs.*.%d ; gdb /proc/%d/exe %d'",
1406 getpid(), getpid(), getpid());
1410 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1411 fn = dlsym(h, "_Insure_trap_error");
1414 ret = fn(a1, a2, a3, a4, a5, a6);
1424 #define MALLOC_MAX 0x40000000
1426 void *_new_array(unsigned long num, unsigned int size, int use_calloc)
1428 if (num >= MALLOC_MAX/size)
1430 return use_calloc ? calloc(num, size) : malloc(num * size);
1433 void *_realloc_array(void *ptr, unsigned int size, size_t num)
1435 if (num >= MALLOC_MAX/size)
1438 return malloc(size * num);
1439 return realloc(ptr, size * num);
1442 /* Take a filename and filename length and return the most significant
1443 * filename suffix we can find. This ignores suffixes such as "~",
1444 * ".bak", ".orig", ".~1~", etc. */
1445 const char *find_filename_suffix(const char *fn, int fn_len, int *len_ptr)
1447 const char *suf, *s;
1451 /* One or more dots at the start aren't a suffix. */
1452 while (fn_len && *fn == '.') fn++, fn_len--;
1454 /* Ignore the ~ in a "foo~" filename. */
1455 if (fn_len > 1 && fn[fn_len-1] == '~')
1456 fn_len--, had_tilde = True;
1460 /* Assume we don't find an suffix. */
1464 /* Find the last significant suffix. */
1465 for (s = fn + fn_len; fn_len > 1; ) {
1466 while (*--s != '.' && s != fn) {}
1469 s_len = fn_len - (s - fn);
1472 if (strcmp(s+1, "bak") == 0
1473 || strcmp(s+1, "old") == 0)
1475 } else if (s_len == 5) {
1476 if (strcmp(s+1, "orig") == 0)
1478 } else if (s_len > 2 && had_tilde
1479 && s[1] == '~' && isDigit(s + 2))
1485 /* Determine if the suffix is all digits. */
1486 for (s++, s_len--; s_len > 0; s++, s_len--) {
1490 /* An all-digit suffix may not be that signficant. */
1497 /* This is an implementation of the Levenshtein distance algorithm. It
1498 * was implemented to avoid needing a two-dimensional matrix (to save
1499 * memory). It was also tweaked to try to factor in the ASCII distance
1500 * between changed characters as a minor distance quantity. The normal
1501 * Levenshtein units of distance (each signifying a single change between
1502 * the two strings) are defined as a "UNIT". */
1504 #define UNIT (1 << 16)
1506 uint32 fuzzy_distance(const char *s1, int len1, const char *s2, int len2)
1508 uint32 a[MAXPATHLEN], diag, above, left, diag_inc, above_inc, left_inc;
1512 if (!len1 || !len2) {
1517 for (i1 = 0, cost = 0; i1 < len1; i1++)
1519 return (int32)len1 * UNIT + cost;
1522 for (i2 = 0; i2 < len2; i2++)
1523 a[i2] = (i2+1) * UNIT;
1525 for (i1 = 0; i1 < len1; i1++) {
1527 above = (i1+1) * UNIT;
1528 for (i2 = 0; i2 < len2; i2++) {
1530 if ((cost = *((uchar*)s1+i1) - *((uchar*)s2+i2)) != 0) {
1536 diag_inc = diag + cost;
1537 left_inc = left + UNIT + *((uchar*)s1+i1);
1538 above_inc = above + UNIT + *((uchar*)s2+i2);
1539 a[i2] = above = left < above
1540 ? (left_inc < diag_inc ? left_inc : diag_inc)
1541 : (above_inc < diag_inc ? above_inc : diag_inc);
1549 #define BB_SLOT_SIZE (16*1024) /* Desired size in bytes */
1550 #define BB_PER_SLOT_BITS (BB_SLOT_SIZE * 8) /* Number of bits per slot */
1551 #define BB_PER_SLOT_INTS (BB_SLOT_SIZE / 4) /* Number of int32s per slot */
1558 struct bitbag *bitbag_create(int max_ndx)
1560 struct bitbag *bb = new(struct bitbag);
1561 bb->slot_cnt = (max_ndx + BB_PER_SLOT_BITS - 1) / BB_PER_SLOT_BITS;
1563 if (!(bb->bits = (uint32**)calloc(bb->slot_cnt, sizeof (uint32*))))
1564 out_of_memory("bitbag_create");
1569 void bitbag_set_bit(struct bitbag *bb, int ndx)
1571 int slot = ndx / BB_PER_SLOT_BITS;
1572 ndx %= BB_PER_SLOT_BITS;
1574 if (!bb->bits[slot]) {
1575 if (!(bb->bits[slot] = (uint32*)calloc(BB_PER_SLOT_INTS, 4)))
1576 out_of_memory("bitbag_set_bit");
1579 bb->bits[slot][ndx/32] |= 1u << (ndx % 32);
1582 #if 0 /* not needed yet */
1583 void bitbag_clear_bit(struct bitbag *bb, int ndx)
1585 int slot = ndx / BB_PER_SLOT_BITS;
1586 ndx %= BB_PER_SLOT_BITS;
1588 if (!bb->bits[slot])
1591 bb->bits[slot][ndx/32] &= ~(1u << (ndx % 32));
1594 int bitbag_check_bit(struct bitbag *bb, int ndx)
1596 int slot = ndx / BB_PER_SLOT_BITS;
1597 ndx %= BB_PER_SLOT_BITS;
1599 if (!bb->bits[slot])
1602 return bb->bits[slot][ndx/32] & (1u << (ndx % 32)) ? 1 : 0;
1606 /* Call this with -1 to start checking from 0. Returns -1 at the end. */
1607 int bitbag_next_bit(struct bitbag *bb, int after)
1610 int i, ndx = after + 1;
1611 int slot = ndx / BB_PER_SLOT_BITS;
1612 ndx %= BB_PER_SLOT_BITS;
1614 mask = (1u << (ndx % 32)) - 1;
1615 for (i = ndx / 32; slot < bb->slot_cnt; slot++, i = mask = 0) {
1616 if (!bb->bits[slot])
1618 for ( ; i < BB_PER_SLOT_INTS; i++, mask = 0) {
1619 if (!(bits = bb->bits[slot][i] & ~mask))
1621 /* The xor magic figures out the lowest enabled bit in
1622 * bits, and the switch quickly computes log2(bit). */
1623 switch (bits ^ (bits & (bits-1))) {
1624 #define LOG2(n) case 1u << n: return slot*BB_PER_SLOT_BITS + i*32 + n
1625 LOG2(0); LOG2(1); LOG2(2); LOG2(3);
1626 LOG2(4); LOG2(5); LOG2(6); LOG2(7);
1627 LOG2(8); LOG2(9); LOG2(10); LOG2(11);
1628 LOG2(12); LOG2(13); LOG2(14); LOG2(15);
1629 LOG2(16); LOG2(17); LOG2(18); LOG2(19);
1630 LOG2(20); LOG2(21); LOG2(22); LOG2(23);
1631 LOG2(24); LOG2(25); LOG2(26); LOG2(27);
1632 LOG2(28); LOG2(29); LOG2(30); LOG2(31);
1634 return -1; /* impossible... */
1641 void flist_ndx_push(flist_ndx_list *lp, int ndx)
1643 struct flist_ndx_item *item;
1645 if (!(item = new(struct flist_ndx_item)))
1646 out_of_memory("flist_ndx_push");
1650 lp->tail->next = item;
1656 int flist_ndx_pop(flist_ndx_list *lp)
1658 struct flist_ndx_item *next;
1664 ndx = lp->head->ndx;
1665 next = lp->head->next;
1674 void *expand_item_list(item_list *lp, size_t item_size,
1675 const char *desc, int incr)
1677 /* First time through, 0 <= 0, so list is expanded. */
1678 if (lp->malloced <= lp->count) {
1680 size_t new_size = lp->malloced;
1682 new_size += -incr; /* increase slowly */
1683 else if (new_size < (size_t)incr)
1687 if (new_size < lp->malloced)
1688 overflow_exit("expand_item_list");
1689 /* Using _realloc_array() lets us pass the size, not a type. */
1690 new_ptr = _realloc_array(lp->items, item_size, new_size);
1692 rprintf(FINFO, "[%s] expand %s to %.0f bytes, did%s move\n",
1693 who_am_i(), desc, (double)new_size * item_size,
1694 new_ptr == lp->items ? " not" : "");
1697 out_of_memory("expand_item_list");
1699 lp->items = new_ptr;
1700 lp->malloced = new_size;
1702 return (char*)lp->items + (lp->count++ * item_size);