changed strlcat() and strlcpy() to have the same semantics as the
[rsync.git] / util.c
diff --git a/util.c b/util.c
index 67308cd2d22e74be57b831b034730ff25f0d0f35..c5bb4a7025200533ad1faad5dfa9fc9c87dc0eaa 100644 (file)
--- a/util.c
+++ b/util.c
   */
 #include "rsync.h"
 
-int num_waiting(int fd)
-{
-  int len=0;
-  ioctl(fd,FIONREAD,&len);
-  return(len);
-}
-
-
-struct map_struct *map_file(int fd,OFF_T len)
+/****************************************************************************
+Set a fd into nonblocking mode. Uses POSIX O_NONBLOCK if available,
+else
+if SYSV use O_NDELAY
+if BSD use FNDELAY
+****************************************************************************/
+int set_nonblocking(int fd)
 {
-  struct map_struct *ret;
-  ret = (struct map_struct *)malloc(sizeof(*ret));
-  if (!ret) out_of_memory("map_file");
-
-  ret->map = NULL;
-  ret->fd = fd;
-  ret->size = len;
-  ret->p = NULL;
-  ret->p_size = 0;
-  ret->p_offset = 0;
-  ret->p_len = 0;
-
-#ifdef HAVE_MMAP
-  if (len < MAX_MAP_SIZE) {
-         ret->map = (char *)mmap(NULL,len,PROT_READ,MAP_SHARED,fd,0);
-         if (ret->map == (char *)-1) {
-                 ret->map = NULL;
-         }
-  }
+       int val;
+#ifdef O_NONBLOCK
+#define FLAG_TO_SET O_NONBLOCK
+#else
+#ifdef SYSV
+#define FLAG_TO_SET O_NDELAY
+#else /* BSD */
+#define FLAG_TO_SET FNDELAY
 #endif
-  return ret;
-}
-
-
-char *map_ptr(struct map_struct *map,OFF_T offset,int len)
-{
-  int nread = -2;
-
-  if (map->map)
-    return map->map+offset;
-
-  if (len == 0) 
-    return NULL;
-
-  if (len > (map->size-offset))
-      len = map->size-offset;
-
-  if (offset >= map->p_offset && 
-      offset+len <= map->p_offset+map->p_len) {
-    return (map->p + (offset - map->p_offset));
-  }
-
-  len = MAX(len,CHUNK_SIZE);
-  if (len > (map->size-offset))
-      len = map->size-offset;
-
-  if (len > map->p_size) {
-    if (map->p) free(map->p);
-    map->p = (char *)malloc(len);
-    if (!map->p) out_of_memory("map_ptr");
-    map->p_size = len;
-  }
-
-  if (do_lseek(map->fd,offset,SEEK_SET) != offset ||
-      (nread=read(map->fd,map->p,len)) != len) {
-         rprintf(FERROR,"EOF in map_ptr! (offset=%d len=%d nread=%d errno=%d)\n",
-                 (int)offset, len, nread, errno);
-         exit_cleanup(1);
-  }
-
-  map->p_offset = offset;
-  map->p_len = len;
-
-  return map->p; 
-}
-
-
-void unmap_file(struct map_struct *map)
-{
-#ifdef HAVE_MMAP
-  if (map->map)
-    munmap(map->map,map->size);
 #endif
-  if (map->p) free(map->p);
-  free(map);
+       
+       if((val = fcntl(fd, F_GETFL, 0)) == -1)
+               return -1;
+       val |= FLAG_TO_SET;
+       return fcntl( fd, F_SETFL, val);
+#undef FLAG_TO_SET
 }
 
 
@@ -122,14 +61,14 @@ int piped_child(char **command,int *f_in,int *f_out)
   if (pipe(to_child_pipe) < 0 ||
       pipe(from_child_pipe) < 0) {
     rprintf(FERROR,"pipe: %s\n",strerror(errno));
-    exit_cleanup(1);
+    exit_cleanup(RERR_IPC);
   }
 
 
   pid = do_fork();
   if (pid < 0) {
     rprintf(FERROR,"fork: %s\n",strerror(errno));
-    exit_cleanup(1);
+    exit_cleanup(RERR_IPC);
   }
 
   if (pid == 0)
@@ -140,7 +79,7 @@ int piped_child(char **command,int *f_in,int *f_out)
          close(from_child_pipe[0]) < 0 ||
          dup2(from_child_pipe[1], STDOUT_FILENO) < 0) {
        rprintf(FERROR,"Failed to dup/close : %s\n",strerror(errno));
-       exit_cleanup(1);
+       exit_cleanup(RERR_IPC);
       }
       if (to_child_pipe[0] != STDIN_FILENO) close(to_child_pipe[0]);
       if (from_child_pipe[1] != STDOUT_FILENO) close(from_child_pipe[1]);
@@ -148,17 +87,20 @@ int piped_child(char **command,int *f_in,int *f_out)
       execvp(command[0], command);
       rprintf(FERROR,"Failed to exec %s : %s\n",
              command[0],strerror(errno));
-      exit_cleanup(1);
+      exit_cleanup(RERR_IPC);
     }
 
   if (close(from_child_pipe[1]) < 0 ||
       close(to_child_pipe[0]) < 0) {
     rprintf(FERROR,"Failed to close : %s\n",strerror(errno));   
-    exit_cleanup(1);
+    exit_cleanup(RERR_IPC);
   }
 
   *f_in = from_child_pipe[0];
   *f_out = to_child_pipe[1];
+
+  set_nonblocking(*f_in);
+  set_nonblocking(*f_out);
   
   return pid;
 }
@@ -172,14 +114,14 @@ int local_child(int argc, char **argv,int *f_in,int *f_out)
        if (pipe(to_child_pipe) < 0 ||
            pipe(from_child_pipe) < 0) {
                rprintf(FERROR,"pipe: %s\n",strerror(errno));
-               exit_cleanup(1);
+               exit_cleanup(RERR_IPC);
        }
 
 
        pid = do_fork();
        if (pid < 0) {
                rprintf(FERROR,"fork: %s\n",strerror(errno));
-               exit_cleanup(1);
+               exit_cleanup(RERR_IPC);
        }
 
        if (pid == 0) {
@@ -194,7 +136,7 @@ int local_child(int argc, char **argv,int *f_in,int *f_out)
                    close(from_child_pipe[0]) < 0 ||
                    dup2(from_child_pipe[1], STDOUT_FILENO) < 0) {
                        rprintf(FERROR,"Failed to dup/close : %s\n",strerror(errno));
-                       exit_cleanup(1);
+                       exit_cleanup(RERR_IPC);
                }
                if (to_child_pipe[0] != STDIN_FILENO) close(to_child_pipe[0]);
                if (from_child_pipe[1] != STDOUT_FILENO) close(from_child_pipe[1]);
@@ -204,7 +146,7 @@ int local_child(int argc, char **argv,int *f_in,int *f_out)
        if (close(from_child_pipe[1]) < 0 ||
            close(to_child_pipe[0]) < 0) {
                rprintf(FERROR,"Failed to close : %s\n",strerror(errno));   
-               exit_cleanup(1);
+               exit_cleanup(RERR_IPC);
        }
 
        *f_in = from_child_pipe[0];
@@ -218,13 +160,13 @@ int local_child(int argc, char **argv,int *f_in,int *f_out)
 void out_of_memory(char *str)
 {
   rprintf(FERROR,"ERROR: out of memory in %s\n",str);
-  exit_cleanup(1);
+  exit_cleanup(RERR_MALLOC);
 }
 
 void overflow(char *str)
 {
   rprintf(FERROR,"ERROR: buffer overflow in %s\n",str);
-  exit_cleanup(1);
+  exit_cleanup(RERR_MALLOC);
 }
 
 
@@ -256,36 +198,6 @@ int set_modtime(char *fname,time_t modtime)
 }
 
 
-
-/****************************************************************************
-Set a fd into blocking/nonblocking mode. Uses POSIX O_NONBLOCK if available,
-else
-if SYSV use O_NDELAY
-if BSD use FNDELAY
-****************************************************************************/
-int set_blocking(int fd, int set)
-{
-  int val;
-#ifdef O_NONBLOCK
-#define FLAG_TO_SET O_NONBLOCK
-#else
-#ifdef SYSV
-#define FLAG_TO_SET O_NDELAY
-#else /* BSD */
-#define FLAG_TO_SET FNDELAY
-#endif
-#endif
-
-  if((val = fcntl(fd, F_GETFL, 0)) == -1)
-       return -1;
-  if(set) /* Turn blocking on - ie. clear nonblock flag */
-       val &= ~FLAG_TO_SET;
-  else
-    val |= FLAG_TO_SET;
-  return fcntl( fd, F_SETFL, val);
-#undef FLAG_TO_SET
-}
-
 /****************************************************************************
 create any necessary directories in fname. Unfortunately we don't know
 what perms to give the directory when this is called so we need to rely
@@ -315,7 +227,7 @@ int create_directory_path(char *fname)
 
    derived from GNU C's cccp.c.
 */
-int full_write(int desc, char *ptr, int len)
+static int full_write(int desc, char *ptr, int len)
 {
        int total_written;
        
@@ -341,7 +253,7 @@ int full_write(int desc, char *ptr, int len)
    for an error.  
 
    derived from GNU C's cccp.c. */
-int safe_read(int desc, char *ptr, int len)
+static int safe_read(int desc, char *ptr, int len)
 {
        int n_chars;
  
@@ -382,7 +294,7 @@ int copy_file(char *source, char *dest, mode_t mode)
        }
 
        ofd = do_open(dest, O_WRONLY | O_CREAT | O_TRUNC | O_EXCL, mode);
-       if (ofd < 0) {
+       if (ofd == -1) {
                rprintf(FERROR,"open %s: %s\n",
                        dest,strerror(errno));
                close(ifd);
@@ -447,13 +359,34 @@ void kill_all(int sig)
 }
 
 /* like strncpy but does not 0 fill the buffer and always null 
-   terminates (thus it can use maxlen+1 space in d) */
-void strlcpy(char *d, char *s, int maxlen)
+   terminates. bufsize is the size of the destination buffer */
+size_t strlcpy(char *d, const char *s, size_t bufsize)
 {
-       int len = strlen(s);
-       if (len > maxlen) len = maxlen;
+       size_t len = strlen(s);
+       size_t ret = len;
+       if (len >= bufsize) len = bufsize-1;
        memcpy(d, s, len);
        d[len] = 0;
+       return ret;
+}
+
+/* like strncat but does not 0 fill the buffer and always null 
+   terminates. bufsize is the length of the buffer, which should
+   be one more than the maximum resulting string length */
+size_t strlcat(char *d, const char *s, size_t bufsize)
+{
+       size_t len1 = strlen(d);
+       size_t len2 = strlen(s);
+       size_t ret = len1 + len2;
+
+       if (len1+len2 >= bufsize) {
+               len2 = bufsize - (len1+1);
+       }
+       if (len2 > 0) {
+               memcpy(d+len1, s, len2);
+               d[len1+len2] = 0;
+       }
+       return ret;
 }
 
 /* turn a user name into a uid */
@@ -482,3 +415,400 @@ int name_to_gid(char *name, gid_t *gid)
        return 0;
 }
 
+
+/* lock a byte range in a open file */
+int lock_range(int fd, int offset, int len)
+{
+       struct flock lock;
+
+       lock.l_type = F_WRLCK;
+       lock.l_whence = SEEK_SET;
+       lock.l_start = offset;
+       lock.l_len = len;
+       lock.l_pid = 0;
+       
+       return fcntl(fd,F_SETLK,&lock) == 0;
+}
+
+
+static void glob_expand_one(char *s, char **argv, int *argc, int maxargs)
+{
+#if !(defined(HAVE_GLOB) && defined(HAVE_GLOB_H))
+       if (!*s) s = ".";
+       argv[*argc] = strdup(s);
+       (*argc)++;
+       return;
+#else
+       glob_t globbuf;
+       int i;
+
+       if (!*s) s = ".";
+
+       argv[*argc] = strdup(s);
+
+       memset(&globbuf, 0, sizeof(globbuf));
+       glob(argv[*argc], 0, NULL, &globbuf);
+       if (globbuf.gl_pathc == 0) {
+               (*argc)++;
+               globfree(&globbuf);
+               return;
+       }
+       for (i=0; i<(maxargs - (*argc)) && i<globbuf.gl_pathc;i++) {
+               if (i == 0) free(argv[*argc]);
+               argv[(*argc) + i] = strdup(globbuf.gl_pathv[i]);
+               if (!argv[(*argc) + i]) out_of_memory("glob_expand");
+       }
+       globfree(&globbuf);
+       (*argc) += i;
+#endif
+}
+
+void glob_expand(char *base1, char **argv, int *argc, int maxargs)
+{
+       char *s = argv[*argc];
+       char *p, *q;
+       char *base = base1;
+
+       if (!s || !*s) return;
+
+       if (strncmp(s, base, strlen(base)) == 0) {
+               s += strlen(base);
+       }
+
+       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);
+
+       q = s;
+       while ((p = strstr(q,base)) && ((*argc) < maxargs)) {
+               /* split it at this point */
+               *p = 0;
+               glob_expand_one(q, argv, argc, maxargs);
+               q = p+strlen(base);
+       }
+
+       if (*q && (*argc < maxargs)) glob_expand_one(q, argv, argc, maxargs);
+
+       free(s);
+       free(base);
+}
+
+/*******************************************************************
+  convert a string to lower case
+********************************************************************/
+void strlower(char *s)
+{
+       while (*s) {
+               if (isupper(*s)) *s = tolower(*s);
+               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);
+       return (void *)realloc(p, size);
+}
+
+
+void clean_fname(char *name)
+{
+       char *p;
+       int l;
+       int modified = 1;
+
+       if (!name) return;
+
+       while (modified) {
+               modified = 0;
+
+               if ((p=strstr(name,"/./"))) {
+                       modified = 1;
+                       while (*p) {
+                               p[0] = p[2];
+                               p++;
+                       }
+               }
+
+               if ((p=strstr(name,"//"))) {
+                       modified = 1;
+                       while (*p) {
+                               p[0] = p[1];
+                               p++;
+                       }
+               }
+
+               if (strncmp(p=name,"./",2) == 0) {      
+                       modified = 1;
+                       do {
+                               p[0] = p[2];
+                       } while (*p++);
+               }
+
+               l = strlen(p=name);
+               if (l > 1 && p[l-1] == '/') {
+                       modified = 1;
+                       p[l-1] = 0;
+               }
+       }
+}
+
+/*
+ * Make path appear as if a chroot had occurred:
+ *    1. remove leading "/" (or replace with "." if at end)
+ *    2. remove leading ".." components
+ *    3. delete any other "<dir>/.." (recursively)
+ * 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.
+ * Return a malloc'ed copy.
+ * Contributed by Dave Dykstra <dwd@bell-labs.com>
+ */
+
+char *sanitize_path(char *p)
+{
+       char *copy, *copyp;
+
+       copy = (char *) malloc(strlen(p)+1);
+       copyp = copy;
+       while (*p == '/') {
+               /* remove leading slashes */
+               p++;
+       }
+       while (*p != '\0') {
+               /* this loop iterates once per filename component in p.
+                * both p (and copyp if the original had a slash) should
+                * always be left pointing after a slash
+                */
+               if ((*p == '.') && ((*(p+1) == '/') || (*(p+1) == '\0'))) {
+                       /* skip "." component */
+                       while (*++p == '/') {
+                               /* skip following slashes */
+                               ;
+                       }
+               } else if ((*p == '.') && (*(p+1) == '.') &&
+                           ((*(p+2) == '/') || (*(p+2) == '\0'))) {
+                       /* skip ".." component followed by slash or end */
+                       p += 2;
+                       if (*p == '/')
+                               p++;
+                       if (copyp != copy) {
+                               /* back up the copy one level */
+                               --copyp; /* now pointing at slash */
+                               while ((copyp > copy) && (*(copyp - 1) != '/')) {
+                                       /* skip back up to slash */
+                                       copyp--;
+                               }
+                       }
+               } else {
+                       while (1) {
+                               /* copy one component through next slash */
+                               *copyp++ = *p++;
+                               if ((*p == '\0') || (*(p-1) == '/')) {
+                                       while (*p == '/') {
+                                               /* skip multiple slashes */
+                                               p++;
+                                       }
+                                       break;
+                               }
+                       }
+               }
+       }
+       if (copyp == copy) {
+               /* ended up with nothing, so put in "." component */
+               *copyp++ = '.';
+       }
+       *copyp = '\0';
+       return(copy);
+}
+
+
+static char curr_dir[MAXPATHLEN];
+
+/* like chdir() but can be reversed with pop_dir() if save is set. It
+   is also much faster as it remembers where we have been */
+char *push_dir(char *dir, int save)
+{
+       char *ret = curr_dir;
+       static int initialised;
+
+       if (!initialised) {
+               initialised = 1;
+               getcwd(curr_dir, sizeof(curr_dir)-1);
+       }
+
+       if (chdir(dir)) return NULL;
+
+       if (save) {
+               ret = strdup(curr_dir);
+       }
+
+       if (*dir == '/') {
+               strlcpy(curr_dir, dir, sizeof(curr_dir));
+       } else {
+               strlcat(curr_dir,"/", sizeof(curr_dir));
+               strlcat(curr_dir,dir, sizeof(curr_dir));
+       }
+
+       clean_fname(curr_dir);
+
+       return ret;
+}
+
+/* reverse a push_dir call */
+int pop_dir(char *dir)
+{
+       int ret;
+
+       ret = chdir(dir);
+       if (ret) {
+               free(dir);
+               return ret;
+       }
+
+       strlcpy(curr_dir, dir, sizeof(curr_dir));
+
+       free(dir);
+
+       return 0;
+}
+
+/* we need to supply our own strcmp function for file list comparisons
+   to ensure that signed/unsigned usage is consistent between machines. */
+int u_strcmp(const char *cs1, const char *cs2)
+{
+       const uchar *s1 = (uchar *)cs1;
+       const uchar *s2 = (uchar *)cs2;
+
+       while (*s1 && *s2 && (*s1 == *s2)) {
+               s1++; s2++;
+       }
+       
+       return (int)*s1 - (int)*s2;
+}
+
+static OFF_T last_ofs;
+
+void end_progress(void)
+{
+       extern int do_progress, am_server;
+
+       if (do_progress && !am_server) {
+               rprintf(FINFO,"\n");
+       }
+       last_ofs = 0;
+}
+
+void show_progress(OFF_T ofs, OFF_T size)
+{
+       extern int do_progress, am_server;
+
+       if (do_progress && !am_server) {
+               if (ofs > last_ofs + 1000) {
+                       int pct = (int)((100.0*ofs)/size);
+                       rprintf(FINFO,"%.0f (%d%%)\r", (double)ofs, pct);
+                       last_ofs = ofs;
+               }
+       }
+}
+
+/* determine if a symlink points outside the current directory tree */
+int unsafe_symlink(char *dest, char *src)
+{
+       char *tok;
+       int depth = 0;
+
+       /* all absolute and null symlinks are unsafe */
+       if (!dest || !(*dest) || (*dest == '/')) return 1;
+
+       src = strdup(src);
+       if (!src) out_of_memory("unsafe_symlink");
+
+       /* find out what our safety margin is */
+       for (tok=strtok(src,"/"); tok; tok=strtok(NULL,"/")) {
+               if (strcmp(tok,"..") == 0) {
+                       depth=0;
+               } else if (strcmp(tok,".") == 0) {
+                       /* nothing */
+               } else {
+                       depth++;
+               }
+       }
+       free(src);
+
+       /* drop by one to account for the filename portion */
+       depth--;
+
+       dest = strdup(dest);
+       if (!dest) out_of_memory("unsafe_symlink");
+
+       for (tok=strtok(dest,"/"); tok; tok=strtok(NULL,"/")) {
+               if (strcmp(tok,"..") == 0) {
+                       depth--;
+               } else if (strcmp(tok,".") == 0) {
+                       /* nothing */
+               } else {
+                       depth++;
+               }
+               /* if at any point we go outside the current directory then
+                  stop - it is unsafe */
+               if (depth < 0) break;
+       }
+
+       free(dest);
+       return (depth < 0);
+}
+
+
+/****************************************************************************
+  return the date and time as a string
+****************************************************************************/
+char *timestring(time_t t)
+{
+       static char TimeBuf[200];
+       struct tm *tm = localtime(&t);
+
+#ifdef HAVE_STRFTIME
+       strftime(TimeBuf,sizeof(TimeBuf)-1,"%Y/%m/%d %T",tm);
+#else
+       strlcpy(TimeBuf, asctime(tm), sizeof(TimeBuf));
+#endif
+
+       if (TimeBuf[strlen(TimeBuf)-1] == '\n') {
+               TimeBuf[strlen(TimeBuf)-1] = 0;
+       }
+
+       return(TimeBuf);
+}
+