IPv6 support is now merged.
[rsync.git] / util.c
diff --git a/util.c b/util.c
index 16d8f6ccf7925a8c69a0973916b50a667be1ba6e..ada404653e3b615135f4c8e5a5a01fd6cfaa61ed 100644 (file)
--- a/util.c
+++ b/util.c
@@ -1,6 +1,8 @@
-/* 
-   Copyright (C) Andrew Tridgell 1996
-   Copyright (C) Paul Mackerras 1996
+/*  -*- c-file-style: "linux" -*-
+    
+    Copyright (C) 1996-2000 by Andrew Tridgell 
+    Copyright (C) Paul Mackerras 1996
+    Copyright (C) 2001 by Martin Pool <mbp@samba.org>
    
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
   */
 #include "rsync.h"
 
+extern int verbose;
+
+
+/****************************************************************************
+Set a fd into nonblocking mode
+****************************************************************************/
+void set_nonblocking(int fd)
+{
+       int val;
+
+       if((val = fcntl(fd, F_GETFL, 0)) == -1)
+               return;
+       if (!(val & NONBLOCK_FLAG)) {
+               val |= NONBLOCK_FLAG;
+               fcntl(fd, F_SETFL, val);
+       }
+}
+
 /****************************************************************************
-Set a fd into nonblocking mode. Uses POSIX O_NONBLOCK if available,
-else
-if SYSV use O_NDELAY
-if BSD use FNDELAY
+Set a fd into blocking mode
 ****************************************************************************/
-int set_nonblocking(int fd)
+void set_blocking(int fd)
 {
        int val;
-#ifdef O_NONBLOCK
-#define FLAG_TO_SET O_NONBLOCK
+
+       if((val = fcntl(fd, F_GETFL, 0)) == -1)
+               return;
+       if (val & NONBLOCK_FLAG) {
+               val &= ~NONBLOCK_FLAG;
+               fcntl(fd, F_SETFL, val);
+       }
+}
+
+
+/* create a file descriptor pair - like pipe() but use socketpair if
+   possible (because of blocking issues on pipes)
+
+   always set non-blocking
+ */
+int fd_pair(int fd[2])
+{
+       int ret;
+
+#if HAVE_SOCKETPAIR
+       ret = socketpair(AF_UNIX, SOCK_STREAM, 0, fd);
 #else
-#ifdef SYSV
-#define FLAG_TO_SET O_NDELAY
-#else /* BSD */
-#define FLAG_TO_SET FNDELAY
-#endif
+       ret = pipe(fd);
 #endif
+
+       if (ret == 0) {
+               set_nonblocking(fd[0]);
+               set_nonblocking(fd[1]);
+       }
        
-       if((val = fcntl(fd, F_GETFL, 0)) == -1)
-               return -1;
-       val |= FLAG_TO_SET;
-       return fcntl( fd, F_SETFL, val);
-#undef FLAG_TO_SET
+       return ret;
 }
 
 
-/* this is taken from CVS */
-int piped_child(char **command,int *f_in,int *f_out)
+/* this is derived from CVS code 
+
+   note that in the child STDIN is set to blocking and STDOUT
+   is set to non-blocking. This is necessary as rsh relies on stdin being blocking
+   and ssh relies on stdout being non-blocking
+
+   if blocking_io is set then use blocking io on both fds. That can be
+   used to cope with badly broken rsh implementations like the one on
+   solaris.
+ */
+pid_t piped_child(char **command,int *f_in,int *f_out)
 {
-  int pid;
+  pid_t pid;
   int to_child_pipe[2];
   int from_child_pipe[2];
+  extern int blocking_io;
 
-  if (pipe(to_child_pipe) < 0 ||
-      pipe(from_child_pipe) < 0) {
+  if (fd_pair(to_child_pipe) < 0 ||
+      fd_pair(from_child_pipe) < 0) {
     rprintf(FERROR,"pipe: %s\n",strerror(errno));
     exit_cleanup(RERR_IPC);
   }
 
 
   pid = do_fork();
-  if (pid < 0) {
+  if (pid == -1) {
     rprintf(FERROR,"fork: %s\n",strerror(errno));
     exit_cleanup(RERR_IPC);
   }
@@ -84,6 +127,10 @@ int piped_child(char **command,int *f_in,int *f_out)
       if (to_child_pipe[0] != STDIN_FILENO) close(to_child_pipe[0]);
       if (from_child_pipe[1] != STDOUT_FILENO) close(from_child_pipe[1]);
       umask(orig_umask);
+      set_blocking(STDIN_FILENO);
+      if (blocking_io) {
+       set_blocking(STDOUT_FILENO);
+      }
       execvp(command[0], command);
       rprintf(FERROR,"Failed to exec %s : %s\n",
              command[0],strerror(errno));
@@ -99,27 +146,25 @@ int piped_child(char **command,int *f_in,int *f_out)
   *f_in = from_child_pipe[0];
   *f_out = to_child_pipe[1];
 
-  set_nonblocking(*f_in);
-  set_nonblocking(*f_out);
-  
   return pid;
 }
 
-int local_child(int argc, char **argv,int *f_in,int *f_out)
+pid_t local_child(int argc, char **argv,int *f_in,int *f_out)
 {
-       int pid;
+       pid_t pid;
        int to_child_pipe[2];
        int from_child_pipe[2];
+       extern int read_batch;  /* dw */
 
-       if (pipe(to_child_pipe) < 0 ||
-           pipe(from_child_pipe) < 0) {
+       if (fd_pair(to_child_pipe) < 0 ||
+           fd_pair(from_child_pipe) < 0) {
                rprintf(FERROR,"pipe: %s\n",strerror(errno));
                exit_cleanup(RERR_IPC);
        }
 
 
        pid = do_fork();
-       if (pid < 0) {
+       if (pid == -1) {
                rprintf(FERROR,"fork: %s\n",strerror(errno));
                exit_cleanup(RERR_IPC);
        }
@@ -128,7 +173,10 @@ int local_child(int argc, char **argv,int *f_in,int *f_out)
                extern int am_sender;
                extern int am_server;
 
-               am_sender = !am_sender;
+               if (read_batch)
+                   am_sender = 0;
+               else
+                   am_sender = !am_sender;
                am_server = 1;          
 
                if (dup2(to_child_pipe[0], STDIN_FILENO) < 0 ||
@@ -280,14 +328,14 @@ int copy_file(char *source, char *dest, mode_t mode)
        char buf[1024 * 8];
        int len;   /* Number of bytes read into `buf'. */
 
-       ifd = open(source, O_RDONLY);
+       ifd = do_open(source, O_RDONLY, 0);
        if (ifd == -1) {
                rprintf(FERROR,"open %s: %s\n",
                        source,strerror(errno));
                return -1;
        }
 
-       if (do_unlink(dest) && errno != ENOENT) {
+       if (robust_unlink(dest) && errno != ENOENT) {
                rprintf(FERROR,"unlink %s: %s\n",
                        dest,strerror(errno));
                return -1;
@@ -323,14 +371,78 @@ int copy_file(char *source, char *dest, mode_t mode)
        return 0;
 }
 
-/* sleep for a while via select */
-void u_sleep(int usec)
+/*
+  Robust unlink: some OS'es (HPUX) refuse to unlink busy files, so
+  rename to <path>/.rsyncNNN instead. Note that successive rsync runs
+  will shuffle the filenames around a bit as long as the file is still
+  busy; this is because this function does not know if the unlink call
+  is due to a new file coming in, or --delete trying to remove old
+  .rsyncNNN files, hence it renames it each time.
+*/
+/* MAX_RENAMES should be 10**MAX_RENAMES_DIGITS */
+#define MAX_RENAMES_DIGITS 3
+#define MAX_RENAMES 1000
+
+int robust_unlink(char *fname)
 {
-       struct timeval tv;
+#ifndef ETXTBSY
+       return do_unlink(fname);
+#else
+       static int counter = 1;
+       int rc, pos, start;
+       char path[MAXPATHLEN];
 
-       tv.tv_sec = 0;
-       tv.tv_usec = usec;
-       select(0, NULL, NULL, NULL, &tv);
+       rc = do_unlink(fname);
+       if ((rc == 0) || (errno != ETXTBSY))
+               return rc;
+
+       strlcpy(path, fname, MAXPATHLEN);
+
+       pos = strlen(path);
+       while((path[--pos] != '/') && (pos >= 0))
+               ;
+       ++pos;
+       strlcpy(&path[pos], ".rsync", MAXPATHLEN-pos);
+       pos += sizeof(".rsync")-1;
+
+       if (pos > (MAXPATHLEN-MAX_RENAMES_DIGITS-1)) {
+               errno = ETXTBSY;
+               return -1;
+       }
+
+       /* start where the last one left off to reduce chance of clashes */
+       start = counter;
+       do {
+               sprintf(&path[pos], "%03d", counter);
+               if (++counter >= MAX_RENAMES)
+                       counter = 1;
+       } while (((rc = access(path, 0)) == 0) && (counter != start));
+
+       if (verbose > 0)
+               rprintf(FINFO,"renaming %s to %s because of text busy\n",
+                                           fname, path);
+
+       /* maybe we should return rename()'s exit status? Nah. */
+       if (do_rename(fname, path) != 0) {
+               errno = ETXTBSY;
+               return -1;
+       }
+       return 0;
+#endif
+}
+
+int robust_rename(char *from, char *to)
+{
+#ifndef ETXTBSY
+       return do_rename(from, to);
+#else
+       int rc = do_rename(from, to);
+       if ((rc == 0) || (errno != ETXTBSY))
+               return rc;
+       if (robust_unlink(to) != 0)
+               return -1;
+       return do_rename(from, to);
+#endif
 }
 
 
@@ -400,7 +512,7 @@ int lock_range(int fd, int offset, int len)
 }
 
 
-static void glob_expand_one(char *s, char **argv, int *argc, int maxargs, int sanitize_paths)
+static void glob_expand_one(char *s, char **argv, int *argc, int maxargs)
 {
 #if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
        if (!*s) s = ".";
@@ -408,14 +520,16 @@ static void glob_expand_one(char *s, char **argv, int *argc, int maxargs, int sa
        (*argc)++;
        return;
 #else
+       extern int sanitize_paths;
        glob_t globbuf;
        int i;
 
        if (!*s) s = ".";
 
-       s = strdup(s);
-       sanitize_path(s);
-       argv[*argc] = s;
+       argv[*argc] = strdup(s);
+       if (sanitize_paths) {
+               sanitize_path(argv[*argc], NULL);
+       }
 
        memset(&globbuf, 0, sizeof(globbuf));
        glob(argv[*argc], 0, NULL, &globbuf);
@@ -434,7 +548,7 @@ static void glob_expand_one(char *s, char **argv, int *argc, int maxargs, int sa
 #endif
 }
 
-void glob_expand(char *base1, char **argv, int *argc, int maxargs, int sanitize_paths)
+void glob_expand(char *base1, char **argv, int *argc, int maxargs)
 {
        char *s = argv[*argc];
        char *p, *q;
@@ -449,20 +563,17 @@ void glob_expand(char *base1, char **argv, int *argc, int maxargs, int sanitize_
        s = strdup(s);
        if (!s) out_of_memory("glob_expand");
 
-       base = (char *)malloc(strlen(base1)+3);
-       if (!base) out_of_memory("glob_expand");
-
-       sprintf(base," %s/", base1);
+       if (asprintf(&base," %s/", base1) <= 0) out_of_memory("glob_expand");
 
        q = s;
        while ((p = strstr(q,base)) && ((*argc) < maxargs)) {
                /* split it at this point */
                *p = 0;
-               glob_expand_one(q, argv, argc, maxargs, sanitize_paths);
+               glob_expand_one(q, argv, argc, maxargs);
                q = p+strlen(base);
        }
 
-       if (*q && (*argc < maxargs)) glob_expand_one(q, argv, argc, maxargs, sanitize_paths);
+       if (*q && (*argc < maxargs)) glob_expand_one(q, argv, argc, maxargs);
 
        free(s);
        free(base);
@@ -479,33 +590,6 @@ void strlower(char *s)
        }
 }
 
-/* this is like vsnprintf but it always null terminates, so you
-   can fit at most n-1 chars in */
-int vslprintf(char *str, int n, const char *format, va_list ap)
-{
-       int ret = vsnprintf(str, n, format, ap);
-       if (ret >= n || ret < 0) {
-               str[n-1] = 0;
-               return -1;
-       }
-       str[ret] = 0;
-       return ret;
-}
-
-
-/* like snprintf but always null terminates */
-int slprintf(char *str, int n, char *format, ...)
-{
-       va_list ap;  
-       int ret;
-
-       va_start(ap, format);
-       ret = vslprintf(str,n,format,ap);
-       va_end(ap);
-       return ret;
-}
-
-
 void *Realloc(void *p, int size)
 {
        if (!p) return (void *)malloc(size);
@@ -558,19 +642,37 @@ void clean_fname(char *name)
 /*
  * Make path appear as if a chroot had occurred:
  *    1. remove leading "/" (or replace with "." if at end)
- *    2. remove leading ".." components
+ *    2. remove leading ".." components (except those allowed by "reldir")
  *    3. delete any other "<dir>/.." (recursively)
+ * Can only shrink paths, so sanitizes in place.
  * While we're at it, remove double slashes and "." components like
  *   clean_fname does(), but DON'T remove a trailing slash because that
  *   is sometimes significant on command line arguments.
- * Can only shrink paths, so sanitizes in place.
+ * If "reldir" is non-null, it is a sanitized directory that the path will be
+ *    relative to, so allow as many ".." at the beginning of the path as
+ *    there are components in reldir.  This is used for symbolic link targets.
+ *    If reldir is non-null and the path began with "/", to be completely like
+ *    a chroot we should add in depth levels of ".." at the beginning of the
+ *    path, but that would blow the assumption that the path doesn't grow and
+ *    it is not likely to end up being a valid symlink anyway, so just do
+ *    the normal removal of the leading "/" instead.
  * Contributed by Dave Dykstra <dwd@bell-labs.com>
  */
 
-void sanitize_path(char *p)
+void sanitize_path(char *p, char *reldir)
 {
        char *start, *sanp;
+       int depth = 0;
+       int allowdotdot = 0;
 
+       if (reldir) {
+               depth++;
+               while (*reldir) {
+                       if (*reldir++ == '/') {
+                               depth++;
+                       }
+               }
+       }
        start = p;
        sanp = p;
        while (*p == '/') {
@@ -588,36 +690,55 @@ void sanitize_path(char *p)
                                /* skip following slashes */
                                ;
                        }
-               } else if ((*p == '.') && (*(p+1) == '.') &&
+                       continue;
+               }
+               allowdotdot = 0;
+               if ((*p == '.') && (*(p+1) == '.') &&
                            ((*(p+2) == '/') || (*(p+2) == '\0'))) {
-                       /* skip ".." component followed by slash or end */
-                       p += 2;
-                       if (*p == '/')
-                               p++;
-                       if (sanp != start) {
-                               /* back up sanp one level */
-                               --sanp; /* now pointing at slash */
-                               while ((sanp > start) && (*(sanp - 1) != '/')) {
-                                       /* skip back up to slash */
-                                       sanp--;
+                       /* ".." component followed by slash or end */
+                       if ((depth > 0) && (sanp == start)) {
+                               /* allow depth levels of .. at the beginning */
+                               --depth;
+                               allowdotdot = 1;
+                       } else {
+                               p += 2;
+                               if (*p == '/')
+                                       p++;
+                               if (sanp != start) {
+                                       /* back up sanp one level */
+                                       --sanp; /* now pointing at slash */
+                                       while ((sanp > start) && (*(sanp - 1) != '/')) {
+                                               /* skip back up to slash */
+                                               sanp--;
+                                       }
                                }
+                               continue;
                        }
-               } else {
-                       while (1) {
-                               /* copy one component through next slash */
-                               *sanp++ = *p++;
-                               if ((*p == '\0') || (*(p-1) == '/')) {
-                                       while (*p == '/') {
-                                               /* skip multiple slashes */
-                                               p++;
-                                       }
-                                       break;
+               }
+               while (1) {
+                       /* copy one component through next slash */
+                       *sanp++ = *p++;
+                       if ((*p == '\0') || (*(p-1) == '/')) {
+                               while (*p == '/') {
+                                       /* skip multiple slashes */
+                                       p++;
                                }
+                               break;
                        }
                }
+               if (allowdotdot) {
+                       /* move the virtual beginning to leave the .. alone */
+                       start = sanp;
+               }
        }
-       if (sanp == start) {
+       if ((sanp == start) && !allowdotdot) {
                /* ended up with nothing, so put in "." component */
+               /*
+                * note that the !allowdotdot doesn't prevent this from
+                *  happening in all allowed ".." situations, but I didn't
+                *  think it was worth putting in an extra variable to ensure
+                *  it since an extra "." won't hurt in those situations.
+                */
                *sanp++ = '.';
        }
        *sanp = '\0';
@@ -692,12 +813,12 @@ int u_strcmp(const char *cs1, const char *cs2)
 
 static OFF_T last_ofs;
 
-void end_progress(void)
+void end_progress(OFF_T size)
 {
        extern int do_progress, am_server;
 
        if (do_progress && !am_server) {
-               rprintf(FINFO,"\n");
+               rprintf(FINFO,"%.0f (100%%)\n", (double)size);
        }
        last_ofs = 0;
 }
@@ -784,3 +905,85 @@ char *timestring(time_t t)
        return(TimeBuf);
 }
 
+
+/**
+ * Sleep for a specified number of milliseconds.
+ *
+ * Always returns TRUE.  (In the future it might return FALSE if
+ * interrupted.)
+ **/
+int msleep(int t)
+{
+       int tdiff=0;
+       struct timeval tval,t1,t2;  
+
+       gettimeofday(&t1, NULL);
+       gettimeofday(&t2, NULL);
+  
+       while (tdiff < t) {
+               tval.tv_sec = (t-tdiff)/1000;
+               tval.tv_usec = 1000*((t-tdiff)%1000);
+               errno = 0;
+               select(0,NULL,NULL, NULL, &tval);
+
+               gettimeofday(&t2, NULL);
+               tdiff = (t2.tv_sec - t1.tv_sec)*1000 + 
+                       (t2.tv_usec - t1.tv_usec)/1000;
+       }
+
+       return True;
+}
+
+
+/*******************************************************************
+ Determine if two file modification times are equivalent (either exact 
+ or in the modification timestamp window established by --modify-window) 
+ Returns 0 if the times should be treated as the same, 1 if the 
+ first is later and -1 if the 2nd is later
+ *******************************************************************/
+int cmp_modtime(time_t file1, time_t file2)
+{
+       extern int modify_window;
+
+       if (file2 > file1) {
+               if (file2 - file1 <= modify_window) return 0;
+               return -1;
+       }
+       if (file1 - file2 <= modify_window) return 0;
+       return 1;
+}
+
+
+#ifdef __INSURE__XX
+#include <dlfcn.h>
+
+/*******************************************************************
+This routine is a trick to immediately catch errors when debugging
+with insure. A xterm with a gdb is popped up when insure catches
+a error. It is Linux specific.
+********************************************************************/
+int _Insure_trap_error(int a1, int a2, int a3, int a4, int a5, int a6)
+{
+       static int (*fn)();
+       int ret;
+       char *cmd;
+
+       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'", 
+               getpid(), getpid(), getpid());
+
+       if (!fn) {
+               static void *h;
+               h = dlopen("/usr/local/parasoft/insure++lite/lib.linux2/libinsure.so", RTLD_LAZY);
+               fn = dlsym(h, "_Insure_trap_error");
+       }
+
+       ret = fn(a1, a2, a3, a4, a5, a6);
+
+       system(cmd);
+
+       free(cmd);
+
+       return ret;
+}
+#endif