1 /* -*- c-file-style: "linux" -*-
3 * Copyright (C) 1996-2000 by Andrew Tridgell
4 * Copyright (C) Paul Mackerras 1996
5 * Copyright (C) 2001, 2002 by Martin Pool <mbp@samba.org>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 * Utilities used in rsync
33 extern int modify_window;
34 extern struct exclude_list_struct server_exclude_list;
36 int sanitize_paths = 0;
41 * Set a fd into nonblocking mode
43 void set_nonblocking(int fd)
47 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
49 if (!(val & NONBLOCK_FLAG)) {
51 fcntl(fd, F_SETFL, val);
56 * Set a fd into blocking mode
58 void set_blocking(int fd)
62 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
64 if (val & NONBLOCK_FLAG) {
65 val &= ~NONBLOCK_FLAG;
66 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])
82 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
88 set_nonblocking(fd[0]);
89 set_nonblocking(fd[1]);
96 void print_child_argv(char **cmd)
98 rprintf(FINFO, "opening connection using ");
100 /* Look for characters that ought to be quoted. This
101 * is not a great quoting algorithm, but it's
102 * sufficient for a log message. */
103 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
104 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
106 ",.-_=+@/") != strlen(*cmd)) {
107 rprintf(FINFO, "\"%s\" ", *cmd);
109 rprintf(FINFO, "%s ", *cmd);
112 rprintf(FINFO, "\n");
116 void out_of_memory(char *str)
118 rprintf(FERROR, "ERROR: out of memory in %s\n", str);
119 exit_cleanup(RERR_MALLOC);
122 void overflow(char *str)
124 rprintf(FERROR, "ERROR: buffer overflow in %s\n", str);
125 exit_cleanup(RERR_MALLOC);
130 int set_modtime(char *fname, time_t modtime)
136 rprintf(FINFO, "set modtime of %s to (%ld) %s",
137 fname, (long) modtime,
138 asctime(localtime(&modtime)));
144 tbuf.actime = time(NULL);
145 tbuf.modtime = modtime;
146 return utime(fname,&tbuf);
147 #elif defined(HAVE_UTIME)
151 return utime(fname,t);
154 t[0].tv_sec = time(NULL);
156 t[1].tv_sec = modtime;
158 return utimes(fname,t);
165 Create any necessary directories in fname. Unfortunately we don't know
166 what perms to give the directory when this is called so we need to rely
169 int create_directory_path(char *fname, int base_umask)
173 while (*fname == '/')
175 while (strncmp(fname, "./", 2) == 0)
179 while ((p = strchr(p,'/')) != NULL) {
181 do_mkdir(fname, 0777 & ~base_umask);
190 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
193 * @retval len upon success
195 * @retval <0 write's (negative) error code
197 * Derived from GNU C's cccp.c.
199 static int full_write(int desc, char *ptr, size_t len)
205 int written = write(desc, ptr, len);
211 total_written += written;
215 return total_written;
220 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
223 * @retval >0 the actual number of bytes read
227 * @retval <0 for an error.
229 * Derived from GNU C's cccp.c. */
230 static int safe_read(int desc, char *ptr, size_t len)
238 n_chars = read(desc, ptr, len);
239 } while (n_chars < 0 && errno == EINTR);
247 * This is used in conjunction with the --temp-dir option */
248 int copy_file(char *source, char *dest, mode_t mode)
253 int len; /* Number of bytes read into `buf'. */
255 ifd = do_open(source, O_RDONLY, 0);
257 rsyserr(FERROR, errno, "open %s", full_fname(source));
261 if (robust_unlink(dest) && errno != ENOENT) {
262 rsyserr(FERROR, errno, "unlink %s", full_fname(dest));
266 ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
268 rsyserr(FERROR, errno, "open %s", full_fname(dest));
273 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
274 if (full_write(ofd, buf, len) < 0) {
275 rsyserr(FERROR, errno, "write %s", full_fname(dest));
283 rsyserr(FERROR, errno, "read %s", full_fname(source));
289 if (close(ifd) < 0) {
290 rsyserr(FINFO, errno, "close failed on %s",
294 if (close(ofd) < 0) {
295 rsyserr(FERROR, errno, "close failed on %s",
303 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
304 #define MAX_RENAMES_DIGITS 3
305 #define MAX_RENAMES 1000
308 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
309 * rename to <path>/.rsyncNNN instead.
311 * Note that successive rsync runs will shuffle the filenames around a
312 * bit as long as the file is still busy; this is because this function
313 * does not know if the unlink call is due to a new file coming in, or
314 * --delete trying to remove old .rsyncNNN files, hence it renames it
317 int robust_unlink(char *fname)
320 return do_unlink(fname);
322 static int counter = 1;
324 char path[MAXPATHLEN];
326 rc = do_unlink(fname);
327 if (rc == 0 || errno != ETXTBSY)
330 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
331 pos = MAXPATHLEN - 1;
333 while (pos > 0 && path[pos-1] != '/')
335 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
337 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
342 /* start where the last one left off to reduce chance of clashes */
345 sprintf(&path[pos], "%03d", counter);
346 if (++counter >= MAX_RENAMES)
348 } while ((rc = access(path, 0)) == 0 && counter != start);
351 rprintf(FINFO,"renaming %s to %s because of text busy\n",
355 /* maybe we should return rename()'s exit status? Nah. */
356 if (do_rename(fname, path) != 0) {
364 /* Returns 0 on success, -1 on most errors, and -2 if we got an error
365 * trying to copy the file across file systems. */
366 int robust_rename(char *from, char *to, int mode)
371 if (do_rename(from, to) == 0)
377 if (robust_unlink(to) != 0)
382 if (copy_file(from, to, mode) != 0)
394 static pid_t all_pids[10];
397 /** Fork and record the pid of the child. **/
400 pid_t newpid = fork();
402 if (newpid != 0 && newpid != -1) {
403 all_pids[num_pids++] = newpid;
411 * @todo It would be kind of nice to make sure that they are actually
412 * all our children before we kill them, because their pids may have
413 * been recycled by some other process. Perhaps when we wait for a
414 * child, we should remove it from this array. Alternatively we could
415 * perhaps use process groups, but I think that would not work on
416 * ancient Unix versions that don't support them.
418 void kill_all(int sig)
422 for (i = 0; i < num_pids; i++) {
423 /* Let's just be a little careful where we
424 * point that gun, hey? See kill(2) for the
425 * magic caused by negative values. */
426 pid_t p = all_pids[i];
438 /** Turn a user name into a uid */
439 int name_to_uid(char *name, uid_t *uid)
442 if (!name || !*name) return 0;
443 pass = getpwnam(name);
451 /** Turn a group name into a gid */
452 int name_to_gid(char *name, gid_t *gid)
455 if (!name || !*name) return 0;
456 grp = getgrnam(name);
465 /** Lock a byte range in a open file */
466 int lock_range(int fd, int offset, int len)
470 lock.l_type = F_WRLCK;
471 lock.l_whence = SEEK_SET;
472 lock.l_start = offset;
476 return fcntl(fd,F_SETLK,&lock) == 0;
479 static int exclude_server_path(char *arg)
483 if (server_exclude_list.head) {
484 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
486 if (check_exclude(&server_exclude_list, arg, 1) < 0) {
487 /* We must leave arg truncated! */
496 static void glob_expand_one(char *s, char **argv, int *argc, int maxargs)
498 #if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
499 if (maxargs <= *argc)
503 s = argv[*argc] = strdup(s);
504 exclude_server_path(s);
513 s = argv[*argc] = strdup(s);
515 sanitize_path(s, NULL);
517 memset(&globbuf, 0, sizeof globbuf);
518 if (!exclude_server_path(s))
519 glob(s, 0, NULL, &globbuf);
520 if (globbuf.gl_pathc == 0) {
525 for (i = 0; i < maxargs - *argc && i < (int)globbuf.gl_pathc; i++) {
528 argv[*argc + i] = strdup(globbuf.gl_pathv[i]);
529 if (!argv[*argc + i])
530 out_of_memory("glob_expand");
537 /* This routine is only used in daemon mode. */
538 void glob_expand(char *base1, char **argv, int *argc, int maxargs)
540 char *s = argv[*argc];
543 int base_len = strlen(base);
545 if (!s || !*s) return;
547 if (strncmp(s, base, base_len) == 0)
551 if (!s) out_of_memory("glob_expand");
553 if (asprintf(&base," %s/", base1) <= 0) out_of_memory("glob_expand");
557 while ((p = strstr(q,base)) != NULL && *argc < maxargs) {
558 /* split it at this point */
560 glob_expand_one(q, argv, argc, maxargs);
564 if (*q && *argc < maxargs)
565 glob_expand_one(q, argv, argc, maxargs);
572 * Convert a string to lower case
574 void strlower(char *s)
577 if (isupper(* (unsigned char *) s))
578 *s = tolower(* (unsigned char *) s);
583 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
584 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
585 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
586 * string fits into destsize. */
587 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
589 size_t len = strlcpy(dest, p1, destsize);
590 if (len < destsize - 1) {
591 if (!len || dest[len-1] != '/')
593 if (len < destsize - 1)
594 len += strlcpy(dest + len, p2, destsize - len);
601 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
605 /* Join any number of strings together, putting them in "dest". The return
606 * value is the length of all the strings, regardless of whether the null-
607 * terminated whole fits in destsize. Your list of string pointers must end
608 * with a NULL to indicate the end of the list. */
609 size_t stringjoin(char *dest, size_t destsize, ...)
615 va_start(ap, destsize);
617 if (!(src = va_arg(ap, const char *)))
624 memcpy(dest, src, len);
635 void clean_fname(char *name)
646 if ((p = strstr(name,"/./")) != NULL) {
654 if ((p = strstr(name,"//")) != NULL) {
662 if (strncmp(p = name, "./", 2) == 0) {
669 l = strlen(p = name);
670 if (l > 1 && p[l-1] == '/') {
678 * Make path appear as if a chroot had occurred:
680 * @li 1. remove leading "/" (or replace with "." if at end)
682 * @li 2. remove leading ".." components (except those allowed by @p reldir)
684 * @li 3. delete any other "<dir>/.." (recursively)
686 * Can only shrink paths, so sanitizes in place.
688 * While we're at it, remove double slashes and "." components like
689 * clean_fname() does, but DON'T remove a trailing slash because that
690 * is sometimes significant on command line arguments.
692 * If @p reldir is non-null, it is a sanitized directory that the path will be
693 * relative to, so allow as many ".." at the beginning of the path as
694 * there are components in reldir. This is used for symbolic link targets.
695 * If reldir is non-null and the path began with "/", to be completely like
696 * a chroot we should add in depth levels of ".." at the beginning of the
697 * path, but that would blow the assumption that the path doesn't grow and
698 * it is not likely to end up being a valid symlink anyway, so just do
699 * the normal removal of the leading "/" instead.
701 * Contributed by Dave Dykstra <dwd@bell-labs.com>
703 void sanitize_path(char *p, char *reldir)
710 int new_component = 1;
712 if (*reldir++ == '/')
714 else if (new_component) {
723 /* remove leading slashes */
727 /* this loop iterates once per filename component in p.
728 * both p (and sanp if the original had a slash) should
729 * always be left pointing after a slash
731 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
732 /* skip "." component */
733 while (*++p == '/') {
734 /* skip following slashes */
740 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
741 /* ".." component followed by slash or end */
742 if (depth > 0 && sanp == start) {
743 /* allow depth levels of .. at the beginning */
751 /* back up sanp one level */
752 --sanp; /* now pointing at slash */
753 while (sanp > start && sanp[-1] != '/') {
754 /* skip back up to slash */
762 /* copy one component through next slash */
764 if (*p == '\0' || p[-1] == '/') {
766 /* skip multiple slashes */
773 /* move the virtual beginning to leave the .. alone */
777 if (sanp == start && !allowdotdot) {
778 /* ended up with nothing, so put in "." component */
780 * note that the !allowdotdot doesn't prevent this from
781 * happening in all allowed ".." situations, but I didn't
782 * think it was worth putting in an extra variable to ensure
783 * it since an extra "." won't hurt in those situations.
790 /* Works much like sanitize_path(), with these differences: (1) a new buffer
791 * is allocated for the sanitized path rather than modifying it in-place; (2)
792 * a leading slash gets transformed into the rootdir value (which can be empty
793 * or NULL if you just want the slash to get dropped); (3) no "reldir" can be
795 char *alloc_sanitize_path(const char *path, const char *rootdir)
798 int rlen, plen = strlen(path);
800 if (*path == '/' && rootdir) {
801 rlen = strlen(rootdir);
806 if (!(buf = new_array(char, rlen + plen + 1)))
807 out_of_memory("alloc_sanitize_path");
809 memcpy(buf, rootdir, rlen);
810 memcpy(buf + rlen, path, plen + 1);
814 sanitize_path(buf + rlen, NULL);
815 if (rlen && buf[rlen] == '.' && buf[rlen+1] == '\0') {
824 char curr_dir[MAXPATHLEN];
825 unsigned int curr_dir_len;
828 * Like chdir(), but it keeps track of the current directory (in the
829 * global "curr_dir"), and ensures that the path size doesn't overflow.
830 * Also cleans the path using the clean_fname() function.
832 int push_dir(char *dir)
834 static int initialised;
839 getcwd(curr_dir, sizeof curr_dir - 1);
840 curr_dir_len = strlen(curr_dir);
843 if (!dir) /* this call was probably just to initialize */
847 if (len == 1 && *dir == '.')
850 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
857 memcpy(curr_dir, dir, len + 1);
860 curr_dir[curr_dir_len++] = '/';
861 memcpy(curr_dir + curr_dir_len, dir, len + 1);
865 clean_fname(curr_dir);
871 * Reverse a push_dir() call. You must pass in an absolute path
872 * that was copied from a prior value of "curr_dir".
874 int pop_dir(char *dir)
879 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
880 if (curr_dir_len >= sizeof curr_dir)
881 curr_dir_len = sizeof curr_dir - 1;
887 * Return a quoted string with the full pathname of the indicated filename.
888 * The string " (in MODNAME)" may also be appended. The returned pointer
889 * remains valid until the next time full_fname() is called.
891 char *full_fname(const char *fn)
893 static char *result = NULL;
906 if (module_id >= 0) {
908 m2 = lp_name(module_id);
911 if (!lp_use_chroot(module_id)) {
912 char *p = lp_path(module_id);
913 if (*p != '/' || p[1])
926 asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
931 /** We need to supply our own strcmp function for file list comparisons
932 to ensure that signed/unsigned usage is consistent between machines. */
933 int u_strcmp(const char *cs1, const char *cs2)
935 const uchar *s1 = (const uchar *)cs1;
936 const uchar *s2 = (const uchar *)cs2;
938 while (*s1 && *s2 && (*s1 == *s2)) {
942 return (int)*s1 - (int)*s2;
948 * Determine if a symlink points outside the current directory tree.
949 * This is considered "unsafe" because e.g. when mirroring somebody
950 * else's machine it might allow them to establish a symlink to
951 * /etc/passwd, and then read it through a web server.
953 * Null symlinks and absolute symlinks are always unsafe.
955 * Basically here we are concerned with symlinks whose target contains
956 * "..", because this might cause us to walk back up out of the
957 * transferred directory. We are not allowed to go back up and
960 * @param dest Target of the symlink in question.
962 * @param src Top source directory currently applicable. Basically this
963 * is the first parameter to rsync in a simple invocation, but it's
964 * modified by flist.c in slightly complex ways.
966 * @retval True if unsafe
967 * @retval False is unsafe
971 int unsafe_symlink(const char *dest, const char *src)
973 const char *name, *slash;
976 /* all absolute and null symlinks are unsafe */
977 if (!dest || !*dest || *dest == '/') return 1;
979 /* find out what our safety margin is */
980 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
981 if (strncmp(name, "../", 3) == 0) {
983 } else if (strncmp(name, "./", 2) == 0) {
989 if (strcmp(name, "..") == 0)
992 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
993 if (strncmp(name, "../", 3) == 0) {
994 /* if at any point we go outside the current directory
995 then stop - it is unsafe */
998 } else if (strncmp(name, "./", 2) == 0) {
1004 if (strcmp(name, "..") == 0)
1012 * Return the date and time as a string
1014 char *timestring(time_t t)
1016 static char TimeBuf[200];
1017 struct tm *tm = localtime(&t);
1019 #ifdef HAVE_STRFTIME
1020 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1022 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1025 if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
1026 TimeBuf[strlen(TimeBuf)-1] = 0;
1034 * Sleep for a specified number of milliseconds.
1036 * Always returns TRUE. (In the future it might return FALSE if
1042 struct timeval tval, t1, t2;
1044 gettimeofday(&t1, NULL);
1045 gettimeofday(&t2, NULL);
1048 tval.tv_sec = (t-tdiff)/1000;
1049 tval.tv_usec = 1000*((t-tdiff)%1000);
1052 select(0,NULL,NULL, NULL, &tval);
1054 gettimeofday(&t2, NULL);
1055 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
1056 (t2.tv_usec - t1.tv_usec)/1000;
1064 * Determine if two file modification times are equivalent (either
1065 * exact or in the modification timestamp window established by
1068 * @retval 0 if the times should be treated as the same
1070 * @retval +1 if the first is later
1072 * @retval -1 if the 2nd is later
1074 int cmp_modtime(time_t file1, time_t file2)
1076 if (file2 > file1) {
1077 if (file2 - file1 <= modify_window)
1081 if (file1 - file2 <= modify_window)
1091 This routine is a trick to immediately catch errors when debugging
1092 with insure. A xterm with a gdb is popped up when insure catches
1093 a error. It is Linux specific.
1095 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1101 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'",
1102 getpid(), getpid(), getpid());
1106 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1107 fn = dlsym(h, "_Insure_trap_error");
1110 ret = fn(a1, a2, a3, a4, a5, a6);
1121 #define MALLOC_MAX 0x40000000
1123 void *_new_array(unsigned int size, unsigned long num)
1125 if (num >= MALLOC_MAX/size)
1127 return malloc(size * num);
1130 void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1132 if (num >= MALLOC_MAX/size)
1134 /* No realloc should need this, but just in case... */
1136 return malloc(size * num);
1137 return realloc(ptr, size * num);