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 char *partial_dir;
35 extern struct exclude_list_struct server_exclude_list;
37 int sanitize_paths = 0;
42 * Set a fd into nonblocking mode
44 void set_nonblocking(int fd)
48 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
50 if (!(val & NONBLOCK_FLAG)) {
52 fcntl(fd, F_SETFL, val);
57 * Set a fd into blocking mode
59 void set_blocking(int fd)
63 if ((val = fcntl(fd, F_GETFL, 0)) == -1)
65 if (val & NONBLOCK_FLAG) {
66 val &= ~NONBLOCK_FLAG;
67 fcntl(fd, F_SETFL, val);
73 * Create a file descriptor pair - like pipe() but use socketpair if
74 * possible (because of blocking issues on pipes).
76 * Always set non-blocking.
78 int fd_pair(int fd[2])
83 ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
89 set_nonblocking(fd[0]);
90 set_nonblocking(fd[1]);
97 void print_child_argv(char **cmd)
99 rprintf(FINFO, "opening connection using ");
100 for (; *cmd; cmd++) {
101 /* Look for characters that ought to be quoted. This
102 * is not a great quoting algorithm, but it's
103 * sufficient for a log message. */
104 if (strspn(*cmd, "abcdefghijklmnopqrstuvwxyz"
105 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
107 ",.-_=+@/") != strlen(*cmd)) {
108 rprintf(FINFO, "\"%s\" ", *cmd);
110 rprintf(FINFO, "%s ", *cmd);
113 rprintf(FINFO, "\n");
117 void out_of_memory(char *str)
119 rprintf(FERROR, "ERROR: out of memory in %s\n", str);
120 exit_cleanup(RERR_MALLOC);
123 void overflow(char *str)
125 rprintf(FERROR, "ERROR: buffer overflow in %s\n", str);
126 exit_cleanup(RERR_MALLOC);
131 int set_modtime(char *fname, time_t modtime)
137 rprintf(FINFO, "set modtime of %s to (%ld) %s",
138 fname, (long)modtime,
139 asctime(localtime(&modtime)));
145 tbuf.actime = time(NULL);
146 tbuf.modtime = modtime;
147 return utime(fname,&tbuf);
148 #elif defined(HAVE_UTIME)
152 return utime(fname,t);
155 t[0].tv_sec = time(NULL);
157 t[1].tv_sec = modtime;
159 return utimes(fname,t);
166 Create any necessary directories in fname. Unfortunately we don't know
167 what perms to give the directory when this is called so we need to rely
170 int create_directory_path(char *fname, int base_umask)
174 while (*fname == '/')
176 while (strncmp(fname, "./", 2) == 0)
180 while ((p = strchr(p,'/')) != NULL) {
182 do_mkdir(fname, 0777 & ~base_umask);
191 * Write @p len bytes at @p ptr to descriptor @p desc, retrying if
194 * @retval len upon success
196 * @retval <0 write's (negative) error code
198 * Derived from GNU C's cccp.c.
200 static int full_write(int desc, char *ptr, size_t len)
206 int written = write(desc, ptr, len);
212 total_written += written;
216 return total_written;
221 * Read @p len bytes at @p ptr from descriptor @p desc, retrying if
224 * @retval >0 the actual number of bytes read
228 * @retval <0 for an error.
230 * Derived from GNU C's cccp.c. */
231 static int safe_read(int desc, char *ptr, size_t len)
239 n_chars = read(desc, ptr, len);
240 } while (n_chars < 0 && errno == EINTR);
248 * This is used in conjunction with the --temp-dir option */
249 int copy_file(char *source, char *dest, mode_t mode)
254 int len; /* Number of bytes read into `buf'. */
256 ifd = do_open(source, O_RDONLY, 0);
258 rsyserr(FERROR, errno, "open %s", full_fname(source));
262 if (robust_unlink(dest) && errno != ENOENT) {
263 rsyserr(FERROR, errno, "unlink %s", full_fname(dest));
267 ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
269 rsyserr(FERROR, errno, "open %s", full_fname(dest));
274 while ((len = safe_read(ifd, buf, sizeof buf)) > 0) {
275 if (full_write(ofd, buf, len) < 0) {
276 rsyserr(FERROR, errno, "write %s", full_fname(dest));
284 rsyserr(FERROR, errno, "read %s", full_fname(source));
290 if (close(ifd) < 0) {
291 rsyserr(FINFO, errno, "close failed on %s",
295 if (close(ofd) < 0) {
296 rsyserr(FERROR, errno, "close failed on %s",
304 /* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
305 #define MAX_RENAMES_DIGITS 3
306 #define MAX_RENAMES 1000
309 * Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
310 * rename to <path>/.rsyncNNN instead.
312 * Note that successive rsync runs will shuffle the filenames around a
313 * bit as long as the file is still busy; this is because this function
314 * does not know if the unlink call is due to a new file coming in, or
315 * --delete trying to remove old .rsyncNNN files, hence it renames it
318 int robust_unlink(char *fname)
321 return do_unlink(fname);
323 static int counter = 1;
325 char path[MAXPATHLEN];
327 rc = do_unlink(fname);
328 if (rc == 0 || errno != ETXTBSY)
331 if ((pos = strlcpy(path, fname, MAXPATHLEN)) >= MAXPATHLEN)
332 pos = MAXPATHLEN - 1;
334 while (pos > 0 && path[pos-1] != '/')
336 pos += strlcpy(path+pos, ".rsync", MAXPATHLEN-pos);
338 if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
343 /* start where the last one left off to reduce chance of clashes */
346 sprintf(&path[pos], "%03d", counter);
347 if (++counter >= MAX_RENAMES)
349 } while ((rc = access(path, 0)) == 0 && counter != start);
352 rprintf(FINFO,"renaming %s to %s because of text busy\n",
356 /* maybe we should return rename()'s exit status? Nah. */
357 if (do_rename(fname, path) != 0) {
365 /* Returns 0 on success, -1 on most errors, and -2 if we got an error
366 * trying to copy the file across file systems. */
367 int robust_rename(char *from, char *to, int mode)
372 if (do_rename(from, to) == 0)
378 if (robust_unlink(to) != 0)
383 if (copy_file(from, to, mode) != 0)
395 static pid_t all_pids[10];
398 /** Fork and record the pid of the child. **/
401 pid_t newpid = fork();
403 if (newpid != 0 && newpid != -1) {
404 all_pids[num_pids++] = newpid;
412 * @todo It would be kind of nice to make sure that they are actually
413 * all our children before we kill them, because their pids may have
414 * been recycled by some other process. Perhaps when we wait for a
415 * child, we should remove it from this array. Alternatively we could
416 * perhaps use process groups, but I think that would not work on
417 * ancient Unix versions that don't support them.
419 void kill_all(int sig)
423 for (i = 0; i < num_pids; i++) {
424 /* Let's just be a little careful where we
425 * point that gun, hey? See kill(2) for the
426 * magic caused by negative values. */
427 pid_t p = all_pids[i];
439 /** Turn a user name into a uid */
440 int name_to_uid(char *name, uid_t *uid)
445 pass = getpwnam(name);
453 /** Turn a group name into a gid */
454 int name_to_gid(char *name, gid_t *gid)
459 grp = getgrnam(name);
468 /** Lock a byte range in a open file */
469 int lock_range(int fd, int offset, int len)
473 lock.l_type = F_WRLCK;
474 lock.l_whence = SEEK_SET;
475 lock.l_start = offset;
479 return fcntl(fd,F_SETLK,&lock) == 0;
482 static int exclude_server_path(char *arg)
486 if (server_exclude_list.head) {
487 for (s = arg; (s = strchr(s, '/')) != NULL; ) {
489 if (check_exclude(&server_exclude_list, arg, 1) < 0) {
490 /* We must leave arg truncated! */
499 static void glob_expand_one(char *s, char ***argv_ptr, int *argc_ptr,
502 char **argv = *argv_ptr;
503 int argc = *argc_ptr;
504 int maxargs = *maxargs_ptr;
505 #if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
506 if (argc == maxargs) {
508 if (!(argv = realloc_array(argv, char *, maxargs)))
509 out_of_memory("glob_expand_one");
511 *maxargs_ptr = maxargs;
515 s = argv[argc++] = strdup(s);
516 exclude_server_path(s);
528 sanitize_path(s, NULL);
530 memset(&globbuf, 0, sizeof globbuf);
531 if (!exclude_server_path(s))
532 glob(s, 0, NULL, &globbuf);
533 if (MAX((int)globbuf.gl_pathc, 1) > maxargs - argc) {
534 maxargs += globbuf.gl_pathc + MAX_ARGS;
535 if (!(argv = realloc_array(argv, char *, maxargs)))
536 out_of_memory("glob_expand_one");
538 *maxargs_ptr = maxargs;
540 if (globbuf.gl_pathc == 0)
543 int j = globbuf.gl_pathc;
545 for (i = 0; i < j; i++) {
546 if (!(argv[argc++] = strdup(globbuf.gl_pathv[i])))
547 out_of_memory("glob_expand_one");
555 /* This routine is only used in daemon mode. */
556 void glob_expand(char *base1, char ***argv_ptr, int *argc_ptr, int *maxargs_ptr)
558 char *s = (*argv_ptr)[*argc_ptr];
561 int base_len = strlen(base);
566 if (strncmp(s, base, base_len) == 0)
569 if (!(s = strdup(s)))
570 out_of_memory("glob_expand");
572 if (asprintf(&base," %s/", base1) <= 0)
573 out_of_memory("glob_expand");
576 for (q = s; *q; q = p + base_len) {
577 if ((p = strstr(q, base)) != NULL)
578 *p = '\0'; /* split it at this point */
579 glob_expand_one(q, argv_ptr, argc_ptr, maxargs_ptr);
589 * Convert a string to lower case
591 void strlower(char *s)
594 if (isupper(*(unsigned char *)s))
595 *s = tolower(*(unsigned char *)s);
600 /* Join strings p1 & p2 into "dest" with a guaranteed '/' between them. (If
601 * p1 ends with a '/', no extra '/' is inserted.) Returns the length of both
602 * strings + 1 (if '/' was inserted), regardless of whether the null-terminated
603 * string fits into destsize. */
604 size_t pathjoin(char *dest, size_t destsize, const char *p1, const char *p2)
606 size_t len = strlcpy(dest, p1, destsize);
607 if (len < destsize - 1) {
608 if (!len || dest[len-1] != '/')
610 if (len < destsize - 1)
611 len += strlcpy(dest + len, p2, destsize - len);
618 len += strlen(p2) + 1; /* Assume we'd insert a '/'. */
622 /* Join any number of strings together, putting them in "dest". The return
623 * value is the length of all the strings, regardless of whether the null-
624 * terminated whole fits in destsize. Your list of string pointers must end
625 * with a NULL to indicate the end of the list. */
626 size_t stringjoin(char *dest, size_t destsize, ...)
632 va_start(ap, destsize);
634 if (!(src = va_arg(ap, const char *)))
641 memcpy(dest, src, len);
652 void clean_fname(char *name)
664 if ((p = strstr(name,"/./")) != NULL) {
672 if ((p = strstr(name,"//")) != NULL) {
680 if (strncmp(p = name, "./", 2) == 0) {
687 l = strlen(p = name);
688 if (l > 1 && p[l-1] == '/') {
696 * Make path appear as if a chroot had occurred:
698 * @li 1. remove leading "/" (or replace with "." if at end)
700 * @li 2. remove leading ".." components (except those allowed by @p reldir)
702 * @li 3. delete any other "<dir>/.." (recursively)
704 * Can only shrink paths, so sanitizes in place.
706 * While we're at it, remove double slashes and "." components like
707 * clean_fname() does, but DON'T remove a trailing slash because that
708 * is sometimes significant on command line arguments.
710 * If @p reldir is non-null, it is a sanitized directory that the path will be
711 * relative to, so allow as many ".." at the beginning of the path as
712 * there are components in reldir. This is used for symbolic link targets.
713 * If reldir is non-null and the path began with "/", to be completely like
714 * a chroot we should add in depth levels of ".." at the beginning of the
715 * path, but that would blow the assumption that the path doesn't grow and
716 * it is not likely to end up being a valid symlink anyway, so just do
717 * the normal removal of the leading "/" instead.
719 * Contributed by Dave Dykstra <dwd@bell-labs.com>
721 void sanitize_path(char *p, char *reldir)
728 int new_component = 1;
730 if (*reldir++ == '/')
732 else if (new_component) {
741 /* remove leading slashes */
745 /* this loop iterates once per filename component in p.
746 * both p (and sanp if the original had a slash) should
747 * always be left pointing after a slash
749 if (*p == '.' && (p[1] == '/' || p[1] == '\0')) {
750 /* skip "." component */
751 while (*++p == '/') {
752 /* skip following slashes */
758 if (*p == '.' && p[1] == '.' && (p[2] == '/' || p[2] == '\0')) {
759 /* ".." component followed by slash or end */
760 if (depth > 0 && sanp == start) {
761 /* allow depth levels of .. at the beginning */
769 /* back up sanp one level */
770 --sanp; /* now pointing at slash */
771 while (sanp > start && sanp[-1] != '/') {
772 /* skip back up to slash */
780 /* copy one component through next slash */
782 if (*p == '\0' || p[-1] == '/') {
784 /* skip multiple slashes */
791 /* move the virtual beginning to leave the .. alone */
795 if (sanp == start && !allowdotdot) {
796 /* ended up with nothing, so put in "." component */
798 * note that the !allowdotdot doesn't prevent this from
799 * happening in all allowed ".." situations, but I didn't
800 * think it was worth putting in an extra variable to ensure
801 * it since an extra "." won't hurt in those situations.
808 /* Works much like sanitize_path(), with these differences: (1) a new buffer
809 * is allocated for the sanitized path rather than modifying it in-place; (2)
810 * a leading slash gets transformed into the rootdir value (which can be empty
811 * or NULL if you just want the slash to get dropped); (3) no "reldir" can be
813 char *alloc_sanitize_path(const char *path, const char *rootdir)
816 int rlen, plen = strlen(path);
818 if (*path == '/' && rootdir) {
819 rlen = strlen(rootdir);
824 if (!(buf = new_array(char, rlen + plen + 1)))
825 out_of_memory("alloc_sanitize_path");
827 memcpy(buf, rootdir, rlen);
828 memcpy(buf + rlen, path, plen + 1);
832 sanitize_path(buf + rlen, NULL);
833 if (rlen && buf[rlen] == '.' && buf[rlen+1] == '\0') {
842 char curr_dir[MAXPATHLEN];
843 unsigned int curr_dir_len;
846 * Like chdir(), but it keeps track of the current directory (in the
847 * global "curr_dir"), and ensures that the path size doesn't overflow.
848 * Also cleans the path using the clean_fname() function.
850 int push_dir(char *dir)
852 static int initialised;
857 getcwd(curr_dir, sizeof curr_dir - 1);
858 curr_dir_len = strlen(curr_dir);
861 if (!dir) /* this call was probably just to initialize */
865 if (len == 1 && *dir == '.')
868 if ((*dir == '/' ? len : curr_dir_len + 1 + len) >= sizeof curr_dir)
875 memcpy(curr_dir, dir, len + 1);
878 curr_dir[curr_dir_len++] = '/';
879 memcpy(curr_dir + curr_dir_len, dir, len + 1);
883 clean_fname(curr_dir);
889 * Reverse a push_dir() call. You must pass in an absolute path
890 * that was copied from a prior value of "curr_dir".
892 int pop_dir(char *dir)
897 curr_dir_len = strlcpy(curr_dir, dir, sizeof curr_dir);
898 if (curr_dir_len >= sizeof curr_dir)
899 curr_dir_len = sizeof curr_dir - 1;
905 * Return the filename, turning any newlines into '?'s. This ensures that
906 * outputting it on a line of its own cannot generate an empty line. This
907 * function can handle only 2 names at a time!
909 const char *safe_fname(const char *fname)
911 static char fbuf1[MAXPATHLEN], fbuf2[MAXPATHLEN];
912 static char *fbuf = fbuf2;
913 char *nl = strchr(fname, '\n');
918 fbuf = fbuf == fbuf1 ? fbuf2 : fbuf1;
919 strlcpy(fbuf, fname, MAXPATHLEN);
920 nl = fbuf + (nl - (char *)fname);
923 } while ((nl = strchr(nl+1, '\n')) != NULL);
929 * Return a quoted string with the full pathname of the indicated filename.
930 * The string " (in MODNAME)" may also be appended. The returned pointer
931 * remains valid until the next time full_fname() is called.
933 char *full_fname(const char *fn)
935 static char *result = NULL;
949 if (module_id >= 0) {
951 m2 = lp_name(module_id);
954 if (!lp_use_chroot(module_id)) {
955 char *p = lp_path(module_id);
956 if (*p != '/' || p[1])
969 asprintf(&result, "\"%s%s%s\"%s%s%s", p1, p2, fn, m1, m2, m3);
974 static char partial_fname[MAXPATHLEN];
976 char *partial_dir_fname(const char *fname)
978 char *t = partial_fname;
979 int sz = sizeof partial_fname;
982 if ((fn = strrchr(fname, '/')) != NULL) {
984 if (*partial_dir != '/') {
985 int len = fn - fname;
986 strncpy(t, fname, len); /* safe */
992 if ((int)pathjoin(t, sz, partial_dir, fn) >= sz)
995 return partial_fname;
998 /* If no --partial-dir option was specified, we don't need to do anything
999 * (the partial-dir is essentially '.'), so just return success. */
1000 int handle_partial_dir(const char *fname, int create)
1004 if (fname != partial_fname)
1006 if (!create && *partial_dir == '/')
1008 if (!(fn = strrchr(partial_fname, '/')))
1012 dir = partial_fname;
1016 int statret = do_lstat(dir, &st);
1018 int statret = do_stat(dir, &st);
1020 if (statret == 0 && !S_ISDIR(st.st_mode)) {
1021 if (do_unlink(dir) < 0)
1025 if (statret < 0 && do_mkdir(dir, 0700) < 0)
1034 /** We need to supply our own strcmp function for file list comparisons
1035 to ensure that signed/unsigned usage is consistent between machines. */
1036 int u_strcmp(const char *cs1, const char *cs2)
1038 const uchar *s1 = (const uchar *)cs1;
1039 const uchar *s2 = (const uchar *)cs2;
1041 while (*s1 && *s2 && (*s1 == *s2)) {
1045 return (int)*s1 - (int)*s2;
1051 * Determine if a symlink points outside the current directory tree.
1052 * This is considered "unsafe" because e.g. when mirroring somebody
1053 * else's machine it might allow them to establish a symlink to
1054 * /etc/passwd, and then read it through a web server.
1056 * Null symlinks and absolute symlinks are always unsafe.
1058 * Basically here we are concerned with symlinks whose target contains
1059 * "..", because this might cause us to walk back up out of the
1060 * transferred directory. We are not allowed to go back up and
1063 * @param dest Target of the symlink in question.
1065 * @param src Top source directory currently applicable. Basically this
1066 * is the first parameter to rsync in a simple invocation, but it's
1067 * modified by flist.c in slightly complex ways.
1069 * @retval True if unsafe
1070 * @retval False is unsafe
1074 int unsafe_symlink(const char *dest, const char *src)
1076 const char *name, *slash;
1079 /* all absolute and null symlinks are unsafe */
1080 if (!dest || !*dest || *dest == '/')
1083 /* find out what our safety margin is */
1084 for (name = src; (slash = strchr(name, '/')) != 0; name = slash+1) {
1085 if (strncmp(name, "../", 3) == 0) {
1087 } else if (strncmp(name, "./", 2) == 0) {
1093 if (strcmp(name, "..") == 0)
1096 for (name = dest; (slash = strchr(name, '/')) != 0; name = slash+1) {
1097 if (strncmp(name, "../", 3) == 0) {
1098 /* if at any point we go outside the current directory
1099 then stop - it is unsafe */
1102 } else if (strncmp(name, "./", 2) == 0) {
1108 if (strcmp(name, "..") == 0)
1116 * Return the date and time as a string
1118 char *timestring(time_t t)
1120 static char TimeBuf[200];
1121 struct tm *tm = localtime(&t);
1123 #ifdef HAVE_STRFTIME
1124 strftime(TimeBuf, sizeof TimeBuf - 1, "%Y/%m/%d %H:%M:%S", tm);
1126 strlcpy(TimeBuf, asctime(tm), sizeof TimeBuf);
1129 if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
1130 TimeBuf[strlen(TimeBuf)-1] = 0;
1138 * Sleep for a specified number of milliseconds.
1140 * Always returns TRUE. (In the future it might return FALSE if
1146 struct timeval tval, t1, t2;
1148 gettimeofday(&t1, NULL);
1151 tval.tv_sec = (t-tdiff)/1000;
1152 tval.tv_usec = 1000*((t-tdiff)%1000);
1155 select(0,NULL,NULL, NULL, &tval);
1157 gettimeofday(&t2, NULL);
1158 tdiff = (t2.tv_sec - t1.tv_sec)*1000 +
1159 (t2.tv_usec - t1.tv_usec)/1000;
1167 * Determine if two file modification times are equivalent (either
1168 * exact or in the modification timestamp window established by
1171 * @retval 0 if the times should be treated as the same
1173 * @retval +1 if the first is later
1175 * @retval -1 if the 2nd is later
1177 int cmp_modtime(time_t file1, time_t file2)
1179 if (file2 > file1) {
1180 if (file2 - file1 <= modify_window)
1184 if (file1 - file2 <= modify_window)
1194 This routine is a trick to immediately catch errors when debugging
1195 with insure. A xterm with a gdb is popped up when insure catches
1196 a error. It is Linux specific.
1198 int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
1204 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'",
1205 getpid(), getpid(), getpid());
1209 h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
1210 fn = dlsym(h, "_Insure_trap_error");
1213 ret = fn(a1, a2, a3, a4, a5, a6);
1224 #define MALLOC_MAX 0x40000000
1226 void *_new_array(unsigned int size, unsigned long num)
1228 if (num >= MALLOC_MAX/size)
1230 return malloc(size * num);
1233 void *_realloc_array(void *ptr, unsigned int size, unsigned long num)
1235 if (num >= MALLOC_MAX/size)
1237 /* No realloc should need this, but just in case... */
1239 return malloc(size * num);
1240 return realloc(ptr, size * num);